qubesync 0.1.0 → 0.2.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 (258) hide show
  1. package/CHANGELOG.md +38 -2
  2. package/README.md +188 -5
  3. package/client.js +660 -0
  4. package/index.d.ts +211 -1
  5. package/index.js +5 -1
  6. package/index.mjs +2 -0
  7. package/operations/account.d.ts +263 -0
  8. package/operations/account.js +50 -0
  9. package/operations/account_tax_line_info.d.ts +31 -0
  10. package/operations/account_tax_line_info.js +26 -0
  11. package/operations/aging_report.d.ts +100 -0
  12. package/operations/aging_report.js +26 -0
  13. package/operations/alert.d.ts +118 -0
  14. package/operations/alert.js +50 -0
  15. package/operations/ar_refund_credit_card.d.ts +201 -0
  16. package/operations/ar_refund_credit_card.js +38 -0
  17. package/operations/bar_code.d.ts +40 -0
  18. package/operations/bar_code.js +26 -0
  19. package/operations/bill.d.ts +612 -0
  20. package/operations/bill.js +50 -0
  21. package/operations/bill_payment_check.d.ts +276 -0
  22. package/operations/bill_payment_check.js +50 -0
  23. package/operations/bill_payment_credit_card.d.ts +178 -0
  24. package/operations/bill_payment_credit_card.js +38 -0
  25. package/operations/bill_to_pay.d.ts +54 -0
  26. package/operations/bill_to_pay.js +26 -0
  27. package/operations/billing_rate.d.ts +159 -0
  28. package/operations/billing_rate.js +38 -0
  29. package/operations/budget_summary_report.d.ts +71 -0
  30. package/operations/budget_summary_report.js +26 -0
  31. package/operations/build_assembly.d.ts +264 -0
  32. package/operations/build_assembly.js +50 -0
  33. package/operations/charge.d.ts +330 -0
  34. package/operations/charge.js +50 -0
  35. package/operations/check.d.ts +394 -0
  36. package/operations/check.js +50 -0
  37. package/operations/class.d.ts +170 -0
  38. package/operations/class.js +50 -0
  39. package/operations/cleared_status.d.ts +43 -0
  40. package/operations/cleared_status.js +26 -0
  41. package/operations/client.d.ts +254 -0
  42. package/operations/company.d.ts +36 -0
  43. package/operations/company.js +26 -0
  44. package/operations/company_activity.d.ts +32 -0
  45. package/operations/company_activity.js +26 -0
  46. package/operations/credit_card_charge.d.ts +280 -0
  47. package/operations/credit_card_charge.js +50 -0
  48. package/operations/credit_card_credit.d.ts +280 -0
  49. package/operations/credit_card_credit.js +50 -0
  50. package/operations/credit_memo.d.ts +642 -0
  51. package/operations/credit_memo.js +50 -0
  52. package/operations/currency.d.ts +195 -0
  53. package/operations/currency.js +50 -0
  54. package/operations/custom_detail_report.d.ts +108 -0
  55. package/operations/custom_detail_report.js +26 -0
  56. package/operations/custom_summary_report.d.ts +119 -0
  57. package/operations/custom_summary_report.js +26 -0
  58. package/operations/customer.d.ts +639 -0
  59. package/operations/customer.js +50 -0
  60. package/operations/customer_msg.d.ts +121 -0
  61. package/operations/customer_msg.js +38 -0
  62. package/operations/customer_type.d.ts +127 -0
  63. package/operations/customer_type.js +38 -0
  64. package/operations/data_event_recovery_info.d.ts +61 -0
  65. package/operations/data_event_recovery_info.js +38 -0
  66. package/operations/data_ext.d.ts +197 -0
  67. package/operations/data_ext.js +50 -0
  68. package/operations/data_ext_def.d.ts +173 -0
  69. package/operations/data_ext_def.js +62 -0
  70. package/operations/date_driven_terms.d.ts +141 -0
  71. package/operations/date_driven_terms.js +38 -0
  72. package/operations/deposit.d.ts +402 -0
  73. package/operations/deposit.js +50 -0
  74. package/operations/employee.d.ts +683 -0
  75. package/operations/employee.js +50 -0
  76. package/operations/employee_default.d.ts +133 -0
  77. package/operations/employee_default.js +38 -0
  78. package/operations/entity.d.ts +96 -0
  79. package/operations/entity.js +26 -0
  80. package/operations/estimate.d.ts +590 -0
  81. package/operations/estimate.js +50 -0
  82. package/operations/form1099_category_account_mapping.d.ts +89 -0
  83. package/operations/form1099_category_account_mapping.js +38 -0
  84. package/operations/general_detail_report.d.ts +108 -0
  85. package/operations/general_detail_report.js +26 -0
  86. package/operations/general_summary_report.d.ts +115 -0
  87. package/operations/general_summary_report.js +26 -0
  88. package/operations/host.d.ts +43 -0
  89. package/operations/host.js +26 -0
  90. package/operations/index.js +397 -0
  91. package/operations/inventory_adjustment.d.ts +389 -0
  92. package/operations/inventory_adjustment.js +50 -0
  93. package/operations/inventory_site.d.ts +247 -0
  94. package/operations/inventory_site.js +50 -0
  95. package/operations/invoice.d.ts +682 -0
  96. package/operations/invoice.js +50 -0
  97. package/operations/item.d.ts +100 -0
  98. package/operations/item.js +26 -0
  99. package/operations/item_assemblies_can_build.d.ts +41 -0
  100. package/operations/item_assemblies_can_build.js +26 -0
  101. package/operations/item_discount.d.ts +256 -0
  102. package/operations/item_discount.js +50 -0
  103. package/operations/item_fixed_asset.d.ts +382 -0
  104. package/operations/item_fixed_asset.js +50 -0
  105. package/operations/item_group.d.ts +236 -0
  106. package/operations/item_group.js +50 -0
  107. package/operations/item_inventory.d.ts +350 -0
  108. package/operations/item_inventory.js +50 -0
  109. package/operations/item_inventory_assembly.d.ts +368 -0
  110. package/operations/item_inventory_assembly.js +50 -0
  111. package/operations/item_non_inventory.d.ts +264 -0
  112. package/operations/item_non_inventory.js +50 -0
  113. package/operations/item_other_charge.d.ts +244 -0
  114. package/operations/item_other_charge.js +50 -0
  115. package/operations/item_payment.d.ts +220 -0
  116. package/operations/item_payment.js +50 -0
  117. package/operations/item_receipt.d.ts +362 -0
  118. package/operations/item_receipt.js +50 -0
  119. package/operations/item_sales_tax.d.ts +228 -0
  120. package/operations/item_sales_tax.js +50 -0
  121. package/operations/item_sales_tax_group.d.ts +192 -0
  122. package/operations/item_sales_tax_group.js +50 -0
  123. package/operations/item_service.d.ts +256 -0
  124. package/operations/item_service.js +50 -0
  125. package/operations/item_sites.d.ts +81 -0
  126. package/operations/item_sites.js +26 -0
  127. package/operations/item_subtotal.d.ts +188 -0
  128. package/operations/item_subtotal.js +50 -0
  129. package/operations/job_report.d.ts +99 -0
  130. package/operations/job_report.js +26 -0
  131. package/operations/job_type.d.ts +127 -0
  132. package/operations/job_type.js +38 -0
  133. package/operations/journal_entry.d.ts +339 -0
  134. package/operations/journal_entry.js +50 -0
  135. package/operations/lead.d.ts +291 -0
  136. package/operations/lead.js +50 -0
  137. package/operations/list.d.ts +39 -0
  138. package/operations/list.js +26 -0
  139. package/operations/list_deleted.d.ts +44 -0
  140. package/operations/list_deleted.js +26 -0
  141. package/operations/list_display.d.ts +65 -0
  142. package/operations/list_display.js +38 -0
  143. package/operations/list_merge.d.ts +58 -0
  144. package/operations/list_merge.js +26 -0
  145. package/operations/other_name.d.ts +280 -0
  146. package/operations/other_name.js +50 -0
  147. package/operations/paycheck.d.ts +82 -0
  148. package/operations/paycheck.js +26 -0
  149. package/operations/payment_method.d.ts +131 -0
  150. package/operations/payment_method.js +38 -0
  151. package/operations/payroll_detail_report.d.ts +97 -0
  152. package/operations/payroll_detail_report.js +26 -0
  153. package/operations/payroll_item.d.ts +83 -0
  154. package/operations/payroll_item.js +26 -0
  155. package/operations/payroll_item_addition.d.ts +95 -0
  156. package/operations/payroll_item_addition.js +38 -0
  157. package/operations/payroll_item_company_contribution.d.ts +105 -0
  158. package/operations/payroll_item_company_contribution.js +38 -0
  159. package/operations/payroll_item_deduction.d.ts +101 -0
  160. package/operations/payroll_item_deduction.js +38 -0
  161. package/operations/payroll_item_direct_deposit.d.ts +65 -0
  162. package/operations/payroll_item_direct_deposit.js +38 -0
  163. package/operations/payroll_item_non_wage.d.ts +92 -0
  164. package/operations/payroll_item_non_wage.js +26 -0
  165. package/operations/payroll_item_tax.d.ts +108 -0
  166. package/operations/payroll_item_tax.js +38 -0
  167. package/operations/payroll_item_wage.d.ts +169 -0
  168. package/operations/payroll_item_wage.js +50 -0
  169. package/operations/payroll_item_workers_compensation.d.ts +77 -0
  170. package/operations/payroll_item_workers_compensation.js +38 -0
  171. package/operations/payroll_last_period.d.ts +31 -0
  172. package/operations/payroll_last_period.js +26 -0
  173. package/operations/payroll_liability_adjustment.d.ts +137 -0
  174. package/operations/payroll_liability_adjustment.js +38 -0
  175. package/operations/payroll_liability_check.d.ts +82 -0
  176. package/operations/payroll_liability_check.js +26 -0
  177. package/operations/payroll_prior_payment.d.ts +126 -0
  178. package/operations/payroll_prior_payment.js +38 -0
  179. package/operations/payroll_summary_report.d.ts +107 -0
  180. package/operations/payroll_summary_report.js +26 -0
  181. package/operations/payroll_year_to_date_adjustment.d.ts +156 -0
  182. package/operations/payroll_year_to_date_adjustment.js +38 -0
  183. package/operations/preferences.d.ts +64 -0
  184. package/operations/preferences.js +38 -0
  185. package/operations/price_level.d.ts +234 -0
  186. package/operations/price_level.js +50 -0
  187. package/operations/purchase_order.d.ts +620 -0
  188. package/operations/purchase_order.js +50 -0
  189. package/operations/qb_command_exec.d.ts +49 -0
  190. package/operations/qb_command_exec.js +26 -0
  191. package/operations/receive_payment.d.ts +450 -0
  192. package/operations/receive_payment.js +50 -0
  193. package/operations/receive_payment_to_deposit.d.ts +36 -0
  194. package/operations/receive_payment_to_deposit.js +26 -0
  195. package/operations/sales_order.d.ts +612 -0
  196. package/operations/sales_order.js +50 -0
  197. package/operations/sales_receipt.d.ts +650 -0
  198. package/operations/sales_receipt.js +50 -0
  199. package/operations/sales_rep.d.ts +170 -0
  200. package/operations/sales_rep.js +50 -0
  201. package/operations/sales_tax_code.d.ts +194 -0
  202. package/operations/sales_tax_code.js +50 -0
  203. package/operations/sales_tax_payable.d.ts +42 -0
  204. package/operations/sales_tax_payable.js +26 -0
  205. package/operations/sales_tax_payment_check.d.ts +254 -0
  206. package/operations/sales_tax_payment_check.js +50 -0
  207. package/operations/sales_tax_return.d.ts +35 -0
  208. package/operations/sales_tax_return.js +26 -0
  209. package/operations/sales_tax_return_line.d.ts +36 -0
  210. package/operations/sales_tax_return_line.js +26 -0
  211. package/operations/ship_method.d.ts +121 -0
  212. package/operations/ship_method.js +38 -0
  213. package/operations/special_account.d.ts +40 -0
  214. package/operations/special_account.js +26 -0
  215. package/operations/special_item.d.ts +44 -0
  216. package/operations/special_item.js +26 -0
  217. package/operations/standard_terms.d.ts +133 -0
  218. package/operations/standard_terms.js +38 -0
  219. package/operations/template.d.ts +36 -0
  220. package/operations/template.js +26 -0
  221. package/operations/terms.d.ts +90 -0
  222. package/operations/terms.js +26 -0
  223. package/operations/time_report.d.ts +84 -0
  224. package/operations/time_report.js +26 -0
  225. package/operations/time_tracking.d.ts +214 -0
  226. package/operations/time_tracking.js +50 -0
  227. package/operations/to_do.d.ts +254 -0
  228. package/operations/to_do.js +50 -0
  229. package/operations/transaction.d.ts +244 -0
  230. package/operations/transaction.js +26 -0
  231. package/operations/transfer.d.ts +178 -0
  232. package/operations/transfer.js +50 -0
  233. package/operations/transfer_inventory.d.ts +290 -0
  234. package/operations/transfer_inventory.js +50 -0
  235. package/operations/txn.d.ts +39 -0
  236. package/operations/txn.js +26 -0
  237. package/operations/txn_deleted.d.ts +44 -0
  238. package/operations/txn_deleted.js +26 -0
  239. package/operations/txn_display.d.ts +69 -0
  240. package/operations/txn_display.js +38 -0
  241. package/operations/txn_void.d.ts +39 -0
  242. package/operations/txn_void.js +26 -0
  243. package/operations/types.d.ts +1259 -0
  244. package/operations/unit_of_measure_set.d.ts +168 -0
  245. package/operations/unit_of_measure_set.js +38 -0
  246. package/operations/vehicle.d.ts +168 -0
  247. package/operations/vehicle.js +50 -0
  248. package/operations/vehicle_mileage.d.ts +147 -0
  249. package/operations/vehicle_mileage.js +38 -0
  250. package/operations/vendor.d.ts +541 -0
  251. package/operations/vendor.js +50 -0
  252. package/operations/vendor_credit.d.ts +365 -0
  253. package/operations/vendor_credit.js +50 -0
  254. package/operations/vendor_type.d.ts +127 -0
  255. package/operations/vendor_type.js +38 -0
  256. package/operations/workers_comp_code.d.ts +199 -0
  257. package/operations/workers_comp_code.js +50 -0
  258. package/package.json +14 -4
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks credit memo operations. Types: credit_memo.d.ts. */
5
+ class CreditMemo {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create credit memo.
15
+ * @param {string} connectionId
16
+ * @param {import("./credit_memo").CreditMemoCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/credit-memos/create-credit-memo
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("credit_memo.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List credit memos (answers in pages, one webhook each).
27
+ * @param {string} connectionId
28
+ * @param {import("./credit_memo").CreditMemoQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/credit-memos/list-credit-memos
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("credit_memo.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update credit memo.
39
+ * @param {string} connectionId
40
+ * @param {import("./credit_memo").CreditMemoUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/credit-memos/update-credit-memo
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("credit_memo.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { CreditMemo };
@@ -0,0 +1,195 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+
3
+ import type { Client } from "../index";
4
+ import type { OperationOptions, QueuedRequest, NameFilter, NameRangeFilter } from "./types";
5
+
6
+ /** QuickBooks currency operations: `qube.currency.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class Currency {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create currency: `POST /connections/{connection_id}/currencies`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `currency_code` (required), `currency_format`, `include_ret_element`, `is_active`, `name` (required), `request_id`.
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/currencies/create-currency
19
+ */
20
+ create(connectionId: string, params: CurrencyCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * List currencies: `GET /connections/{connection_id}/currencies`, queued for QuickBooks.
23
+ *
24
+ * The answer comes to `webhookUrl` as one webhook.
25
+ * Params go in the query string.
26
+ *
27
+ * Fields: `active_status`, `from_modified_date`, `full_name`, `include_ret_element`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `request_id`, `to_modified_date`.
28
+ *
29
+ * Resolves to the queued request.
30
+ * @see https://docs.qubesync.com/api-reference/v2/currencies/list-currencies
31
+ */
32
+ query(connectionId: string, params: CurrencyQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
33
+ /**
34
+ * Update currency: `PUT /connections/{connection_id}/currencies`, queued for QuickBooks.
35
+ *
36
+ * The answer comes to `webhookUrl` as one webhook.
37
+ * Params go in the JSON body.
38
+ *
39
+ * Fields: `currency_code`, `currency_format`, `edit_sequence` (required), `include_ret_element`, `is_active`, `list_id` (required), `name`, `request_id`.
40
+ *
41
+ * Resolves to the queued request.
42
+ * @see https://docs.qubesync.com/api-reference/v2/currencies/update-currency
43
+ */
44
+ update(connectionId: string, params: CurrencyUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
45
+ }
46
+
47
+ /**
48
+ * The params of `currency.create`: Create currency.
49
+ */
50
+ export interface CurrencyCreateParams {
51
+ /**
52
+ * For built-in currencies, the currency code and name is the generally accepted code and name. These are based on the standard ISO 4217 code/name for a country’s currency. In most cases, the currency code is composed of the country’s two-character Internet country code plus an extra character representing the currency unit.
53
+ */
54
+ currency_code: string;
55
+ /**
56
+ * The aggregate controlling the appearance of the currency with regard to comma and decimal.
57
+ */
58
+ currency_format?: CurrencyFormat;
59
+ include_ret_element?: Array<"AsOfDate" | "CurrencyCode" | "CurrencyFormat" | "EditSequence" | "ExchangeRate" | "ExternalGUID" | "IsActive" | "IsUserDefinedCurrency" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
60
+ /**
61
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
62
+ */
63
+ is_active?: boolean;
64
+ /**
65
+ * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because FullName remains distinct.
66
+ */
67
+ name: string;
68
+ /**
69
+ * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
70
+ */
71
+ request_id?: string;
72
+ }
73
+
74
+ /**
75
+ * The params of `currency.query`: List currencies.
76
+ */
77
+ export interface CurrencyQueryParams {
78
+ /**
79
+ * Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
80
+ *
81
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
82
+ */
83
+ active_status?: "ActiveOnly" | "All" | "InactiveOnly";
84
+ /**
85
+ * Filters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00.
86
+ *
87
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
88
+ *
89
+ * Format: date-time.
90
+ */
91
+ from_modified_date?: string;
92
+ /**
93
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
94
+ */
95
+ full_name?: string[];
96
+ include_ret_element?: Array<"AsOfDate" | "CurrencyCode" | "CurrencyFormat" | "EditSequence" | "ExchangeRate" | "IsActive" | "IsUserDefinedCurrency" | "ListID" | "Name" | "TimeCreated" | "TimeModified">;
97
+ /**
98
+ * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
99
+ *
100
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
101
+ */
102
+ list_id?: string[];
103
+ /**
104
+ * Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) If you include a `max_returned` value, it must be at least 1.
105
+ *
106
+ * QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
107
+ *
108
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
109
+ *
110
+ * Minimum 1.
111
+ */
112
+ max_returned?: number;
113
+ /**
114
+ * Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
115
+ */
116
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
117
+ /**
118
+ * Filters according to the object’s Name.
119
+ *
120
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
121
+ */
122
+ name_filter?: NameFilter;
123
+ /**
124
+ * Filters according to the object’s Name.
125
+ *
126
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
127
+ */
128
+ name_range_filter?: NameRangeFilter;
129
+ /**
130
+ * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
131
+ */
132
+ request_id?: string;
133
+ /**
134
+ * Filters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59).
135
+ *
136
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
137
+ *
138
+ * Format: date-time.
139
+ */
140
+ to_modified_date?: string;
141
+ }
142
+
143
+ /**
144
+ * The params of `currency.update`: Update currency.
145
+ */
146
+ export interface CurrencyUpdateParams {
147
+ /**
148
+ * For built-in currencies, the currency code and name is the generally accepted code and name. These are based on the standard ISO 4217 code/name for a country’s currency. In most cases, the currency code is composed of the country’s two-character Internet country code plus an extra character representing the currency unit.
149
+ */
150
+ currency_code?: string;
151
+ /**
152
+ * The aggregate controlling the appearance of the currency with regard to comma and decimal.
153
+ */
154
+ currency_format?: CurrencyFormat;
155
+ /**
156
+ * `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes.
157
+ */
158
+ edit_sequence: string;
159
+ include_ret_element?: Array<"AsOfDate" | "CurrencyCode" | "CurrencyFormat" | "EditSequence" | "ExchangeRate" | "ExternalGUID" | "IsActive" | "IsUserDefinedCurrency" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
160
+ /**
161
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
162
+ */
163
+ is_active?: boolean;
164
+ /**
165
+ * `list_id` and FullName both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both FullName and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores FullName.
166
+ */
167
+ list_id: string;
168
+ /**
169
+ * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because FullName remains distinct.
170
+ */
171
+ name?: string;
172
+ /**
173
+ * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
174
+ */
175
+ request_id?: string;
176
+ }
177
+
178
+ export interface CurrencyFormat {
179
+ /**
180
+ * This enumerated value controls the display of the decimal value, for example, 1.00. The default is 2 which means 2 decimals are displayed to the right of the decimal point, but you can specify 0 (zero) if you don’t want’ decimals to be displayed.
181
+ */
182
+ decimal_places?: "0" | "2";
183
+ /**
184
+ * This enumerated value controls the display of the decimal point, for example, 1.00 or 1,00. The default is Period but you could alternatively specify a value of Comma.
185
+ */
186
+ decimal_separator?: "Comma" | "Period";
187
+ /**
188
+ * This enumerated value controls how the thousandth’s place is separated from the next thousand, for example, 1,000,000. The default is Comma, as shown, but you can replace this with one of these values: Period, Space, Apostrophe .
189
+ */
190
+ thousand_separator?: "Apostrophe" | "Comma" | "Period" | "Space";
191
+ /**
192
+ * This enumerated value controls how the display of the currency value is grouped, for example, 10,000,000. The default is XX_XXX_XXX but you could replace this with X_XX_XX_XXX
193
+ */
194
+ thousand_separator_grouping?: "XX_XXX_XXX" | "X_XX_XX_XXX";
195
+ }
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks currency operations. Types: currency.d.ts. */
5
+ class Currency {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create currency.
15
+ * @param {string} connectionId
16
+ * @param {import("./currency").CurrencyCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/currencies/create-currency
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("currency.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List currencies.
27
+ * @param {string} connectionId
28
+ * @param {import("./currency").CurrencyQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/currencies/list-currencies
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("currency.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update currency.
39
+ * @param {string} connectionId
40
+ * @param {import("./currency").CurrencyUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/currencies/update-currency
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("currency.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { Currency };
@@ -0,0 +1,108 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+
3
+ import type { Client } from "../index";
4
+ import type { OperationOptions, QueuedRequest, ReportAccountFilter, ReportClassFilter, ReportEntityFilter, ReportItemFilter, ReportModifiedDateRangeFilter, ReportPeriod, ReportTxnTypeFilter } from "./types";
5
+
6
+ /** QuickBooks custom detail report operations: `qube.customDetailReport.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class CustomDetailReport {
8
+ constructor(client: Client);
9
+ /**
10
+ * List custom detail reports: `GET /connections/{connection_id}/custom-detail-reports`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the query string.
14
+ *
15
+ * Fields: `custom_detail_report_type` (required), `display_report`, `include_accounts`, `include_column` (required), `report_account_filter`, `report_basis`, `report_class_filter`, `report_date_macro`, `report_detail_level_filter`, `report_entity_filter`, `report_item_filter`, `report_modified_date_range_filter`, `report_modified_date_range_macro`, `report_open_balance_as_of`, `report_period`, `report_posting_status_filter`, `report_txn_type_filter`, `request_id`, `summarize_rows_by` (required).
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/custom-detail-reports/list-custom-detail-reports
19
+ */
20
+ query(connectionId: string, params: CustomDetailReportQueryParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ }
22
+
23
+ /**
24
+ * The params of `custom_detail_report.query`: List custom detail reports.
25
+ */
26
+ export interface CustomDetailReportQueryParams {
27
+ /**
28
+ * The type of report being queried.
29
+ */
30
+ custom_detail_report_type: "CustomTxnDetail";
31
+ /**
32
+ * Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the responseData attribute to includeNone.
33
+ */
34
+ display_report?: boolean;
35
+ /**
36
+ * Indicates whether this report should include all accounts or just those that are currently in use.
37
+ */
38
+ include_accounts?: "All" | "InUse";
39
+ include_column: Array<"Account" | "Aging" | "Amount" | "AmountDifference" | "AverageCost" | "BilledDate" | "BillingStatus" | "CalculatedAmount" | "Class" | "ClearedStatus" | "CostPrice" | "Credit" | "Currency" | "Date" | "Debit" | "DeliveryDate" | "DueDate" | "EstimateActive" | "ExchangeRate" | "FOB" | "IncomeSubjectToTax" | "Invoiced" | "Item" | "ItemDesc" | "LastModifiedBy" | "LatestOrPriorState" | "Memo" | "ModifiedTime" | "Name" | "NameAccountNumber" | "NameAddress" | "NameCity" | "NameContact" | "NameEmail" | "NameFax" | "NamePhone" | "NameState" | "NameZip" | "OpenBalance" | "OriginalAmount" | "PONumber" | "PaidAmount" | "PaidStatus" | "PaidThroughDate" | "PaymentMethod" | "PayrollItem" | "PrintStatus" | "ProgressAmount" | "ProgressPercent" | "Quantity" | "QuantityAvailable" | "QuantityOnHand" | "QuantityOnSalesOrder" | "ReceivedQuantity" | "RefNumber" | "RunningBalance" | "SSNOrTaxID" | "SalesRep" | "SalesTaxCode" | "SerialOrLotNumber" | "ShipDate" | "ShipMethod" | "SourceName" | "SplitAccount" | "TaxLine" | "TaxTableVersion" | "Terms" | "TxnID" | "TxnNumber" | "TxnType" | "UnitPrice" | "UserEdit" | "ValueOnHand" | "WageBase" | "WageBaseTips">;
40
+ /**
41
+ * Allows you to query for a specified account type or for specific list elements.
42
+ */
43
+ report_account_filter?: ReportAccountFilter;
44
+ /**
45
+ * If `report_basis` is rbCash, the report bases income and expenses on the dates when money changed hands.rbAccrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered.rbNone, the report uses the default `report_basis`, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report.
46
+ */
47
+ report_basis?: "Accrual" | "Cash" | "None";
48
+ /**
49
+ * Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
50
+ */
51
+ report_class_filter?: ReportClassFilter;
52
+ /**
53
+ * The time period covered by this report.
54
+ *
55
+ * Choose at most one of: `report_period`, or `report_date_macro`.
56
+ */
57
+ report_date_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
58
+ /**
59
+ * The level of detail to include in the report.
60
+ */
61
+ report_detail_level_filter?: "All" | "AllExceptSummary" | "SummaryOnly";
62
+ /**
63
+ * Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements.
64
+ */
65
+ report_entity_filter?: ReportEntityFilter;
66
+ /**
67
+ * Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements.
68
+ */
69
+ report_item_filter?: ReportItemFilter;
70
+ /**
71
+ * Returns reports that were modified between these two dates (inclusive). The range of acceptable dates for both `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
72
+ *
73
+ * Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
74
+ */
75
+ report_modified_date_range_filter?: ReportModifiedDateRangeFilter;
76
+ /**
77
+ * The time period covered by this report.
78
+ *
79
+ * Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
80
+ */
81
+ report_modified_date_range_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
82
+ /**
83
+ * The report will return open balance information up to the `report_open_balance_as_of` date.
84
+ */
85
+ report_open_balance_as_of?: "ReportEndDate" | "Today";
86
+ /**
87
+ * If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date.
88
+ *
89
+ * Choose at most one of: `report_period`, or `report_date_macro`.
90
+ */
91
+ report_period?: ReportPeriod;
92
+ /**
93
+ * Allows you to query for posting reports, non-posting reports, or reports that are either one.
94
+ */
95
+ report_posting_status_filter?: "Either" | "NonPosting" | "Posting";
96
+ /**
97
+ * Allows you to report on specific transaction types (for example, charge, check, deposit, or estimate).
98
+ */
99
+ report_txn_type_filter?: ReportTxnTypeFilter;
100
+ /**
101
+ * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
102
+ */
103
+ request_id?: string;
104
+ /**
105
+ * `summarize_rows_by` (along with IncludeColumnList, in most cases) determines what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to srbAccount, the report’s row labels might be “Checking,” “Savings,” and so on.
106
+ */
107
+ summarize_rows_by: "Account" | "BalanceSheet" | "Class" | "Customer" | "CustomerType" | "Day" | "Employee" | "FourWeek" | "HalfMonth" | "IncomeStatement" | "ItemDetail" | "ItemType" | "Month" | "Payee" | "PaymentMethod" | "PayrollItemDetail" | "PayrollYtdDetail" | "Quarter" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "TaxLine" | "Terms" | "TotalOnly" | "TwoWeek" | "Vendor" | "VendorType" | "Week" | "Year";
108
+ }
@@ -0,0 +1,26 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks custom detail report operations. Types: custom_detail_report.d.ts. */
5
+ class CustomDetailReport {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * List custom detail reports.
15
+ * @param {string} connectionId
16
+ * @param {import("./custom_detail_report").CustomDetailReportQueryParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/custom-detail-reports/list-custom-detail-reports
20
+ */
21
+ query(connectionId, params, options) {
22
+ return this.#client.queue("custom_detail_report.query", connectionId, params, options);
23
+ }
24
+ }
25
+
26
+ module.exports = { CustomDetailReport };
@@ -0,0 +1,119 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+
3
+ import type { Client } from "../index";
4
+ import type { OperationOptions, QueuedRequest, ReportAccountFilter, ReportClassFilter, ReportEntityFilter, ReportItemFilter, ReportModifiedDateRangeFilter, ReportPeriod, ReportTxnTypeFilter } from "./types";
5
+
6
+ /** QuickBooks custom summary report operations: `qube.customSummaryReport.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class CustomSummaryReport {
8
+ constructor(client: Client);
9
+ /**
10
+ * List custom summary reports: `GET /connections/{connection_id}/custom-summary-reports`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the query string.
14
+ *
15
+ * Fields: `custom_summary_report_type` (required), `display_report`, `include_subcolumns`, `report_account_filter`, `report_basis`, `report_calendar`, `report_class_filter`, `report_date_macro`, `report_detail_level_filter`, `report_entity_filter`, `report_item_filter`, `report_modified_date_range_filter`, `report_modified_date_range_macro`, `report_period`, `report_posting_status_filter`, `report_txn_type_filter`, `request_id`, `return_columns`, `return_rows`, `summarize_columns_by` (required), `summarize_rows_by` (required).
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/custom-summary-reports/list-custom-summary-reports
19
+ */
20
+ query(connectionId: string, params: CustomSummaryReportQueryParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ }
22
+
23
+ /**
24
+ * The params of `custom_summary_report.query`: List custom summary reports.
25
+ */
26
+ export interface CustomSummaryReportQueryParams {
27
+ /**
28
+ * The type of report being queried.
29
+ */
30
+ custom_summary_report_type: "CustomSummary";
31
+ /**
32
+ * Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the responseData attribute to includeNone.
33
+ */
34
+ display_report?: boolean;
35
+ /**
36
+ * The default value is false, which means that the report won’t include any subcolumn information. To include all available types of subcolumns for this report, set `include_subcolumns` to true. The SDK won’t return subcolumn information for data that can be easily computed. (For example, the SDK doesn’t return the “percent of row” column.)
37
+ */
38
+ include_subcolumns?: boolean;
39
+ /**
40
+ * Allows you to query for a specified account type or for specific list elements.
41
+ */
42
+ report_account_filter?: ReportAccountFilter;
43
+ /**
44
+ * If `report_basis` is rbCash, the report bases income and expenses on the dates when money changed hands.rbAccrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered.rbNone, the report uses the default `report_basis`, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report.
45
+ */
46
+ report_basis?: "Accrual" | "Cash" | "None";
47
+ /**
48
+ * Specifies the type of year that will be used for this report.
49
+ */
50
+ report_calendar?: "CalendarYear" | "FiscalYear" | "TaxYear";
51
+ /**
52
+ * Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
53
+ */
54
+ report_class_filter?: ReportClassFilter;
55
+ /**
56
+ * The time period covered by this report.
57
+ *
58
+ * Choose at most one of: `report_period`, or `report_date_macro`.
59
+ */
60
+ report_date_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
61
+ /**
62
+ * The level of detail to include in the report.
63
+ */
64
+ report_detail_level_filter?: "All" | "AllExceptSummary" | "SummaryOnly";
65
+ /**
66
+ * Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements.
67
+ */
68
+ report_entity_filter?: ReportEntityFilter;
69
+ /**
70
+ * Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements.
71
+ */
72
+ report_item_filter?: ReportItemFilter;
73
+ /**
74
+ * Returns reports that were modified between these two dates (inclusive). The range of acceptable dates for both `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
75
+ *
76
+ * Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
77
+ */
78
+ report_modified_date_range_filter?: ReportModifiedDateRangeFilter;
79
+ /**
80
+ * The time period covered by this report.
81
+ *
82
+ * Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
83
+ */
84
+ report_modified_date_range_macro?: "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
85
+ /**
86
+ * If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date.
87
+ *
88
+ * Choose at most one of: `report_period`, or `report_date_macro`.
89
+ */
90
+ report_period?: ReportPeriod;
91
+ /**
92
+ * Allows you to query for posting reports, non-posting reports, or reports that are either one.
93
+ */
94
+ report_posting_status_filter?: "Either" | "NonPosting" | "Posting";
95
+ /**
96
+ * Allows you to report on specific transaction types (for example, charge, check, deposit, or estimate).
97
+ */
98
+ report_txn_type_filter?: ReportTxnTypeFilter;
99
+ /**
100
+ * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
101
+ */
102
+ request_id?: string;
103
+ /**
104
+ * Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
105
+ */
106
+ return_columns?: "ActiveOnly" | "All" | "NonZero";
107
+ /**
108
+ * Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
109
+ */
110
+ return_rows?: "ActiveOnly" | "All" | "NonZero";
111
+ /**
112
+ * `summarize_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report. For example, if you set the value to scbTwoWeek, the report’s column labels might be “Feb 10-23, 02,” “Feb 24-Mar9, 02,” and so on.
113
+ */
114
+ summarize_columns_by: "Account" | "BalanceSheet" | "Class" | "Customer" | "CustomerType" | "Day" | "Employee" | "FourWeek" | "HalfMonth" | "IncomeStatement" | "ItemDetail" | "ItemType" | "Month" | "Payee" | "PaymentMethod" | "PayrollItemDetail" | "PayrollYtdDetail" | "Quarter" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "Terms" | "TotalOnly" | "TwoWeek" | "Vendor" | "VendorType" | "Week" | "Year";
115
+ /**
116
+ * `summarize_rows_by` (along with IncludeColumnList, in most cases) determines what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to srbAccount, the report’s row labels might be “Checking,” “Savings,” and so on.
117
+ */
118
+ summarize_rows_by: "Account" | "BalanceSheet" | "Class" | "Customer" | "CustomerType" | "Day" | "Employee" | "FourWeek" | "HalfMonth" | "IncomeStatement" | "ItemDetail" | "ItemType" | "Month" | "Payee" | "PaymentMethod" | "PayrollItemDetail" | "PayrollYtdDetail" | "Quarter" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "TaxLine" | "Terms" | "TotalOnly" | "TwoWeek" | "Vendor" | "VendorType" | "Week" | "Year";
119
+ }
@@ -0,0 +1,26 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks custom summary report operations. Types: custom_summary_report.d.ts. */
5
+ class CustomSummaryReport {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * List custom summary reports.
15
+ * @param {string} connectionId
16
+ * @param {import("./custom_summary_report").CustomSummaryReportQueryParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/custom-summary-reports/list-custom-summary-reports
20
+ */
21
+ query(connectionId, params, options) {
22
+ return this.#client.queue("custom_summary_report.query", connectionId, params, options);
23
+ }
24
+ }
25
+
26
+ module.exports = { CustomSummaryReport };