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 sales receipt operations. Types: sales_receipt.d.ts. */
5
+ class SalesReceipt {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create sales receipt.
15
+ * @param {string} connectionId
16
+ * @param {import("./sales_receipt").SalesReceiptCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/sales-receipts/create-sales-receipt
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("sales_receipt.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List sales receipts (answers in pages, one webhook each).
27
+ * @param {string} connectionId
28
+ * @param {import("./sales_receipt").SalesReceiptQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/sales-receipts/list-sales-receipts
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("sales_receipt.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update sales receipt.
39
+ * @param {string} connectionId
40
+ * @param {import("./sales_receipt").SalesReceiptUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/sales-receipts/update-sales-receipt
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("sales_receipt.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { SalesReceipt };
@@ -0,0 +1,170 @@
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, CurrencyRef, NameFilter, NameRangeFilter } from "./types";
5
+
6
+ /** QuickBooks sales rep operations: `qube.salesRep.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class SalesRep {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create sales rep: `POST /connections/{connection_id}/sales-reps`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `include_ret_element`, `initial` (required), `is_active`, `request_id`, `sales_rep_entity_ref` (required).
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/sales-reps/create-sales-rep
19
+ */
20
+ create(connectionId: string, params: SalesRepCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * List sales reps: `GET /connections/{connection_id}/sales-reps`, 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/sales-reps/list-sales-reps
31
+ */
32
+ query(connectionId: string, params: SalesRepQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
33
+ /**
34
+ * Update sales rep: `PUT /connections/{connection_id}/sales-reps`, queued for QuickBooks.
35
+ *
36
+ * The answer comes to `webhookUrl` as one webhook.
37
+ * Params go in the JSON body.
38
+ *
39
+ * Fields: `edit_sequence` (required), `include_ret_element`, `initial`, `is_active`, `list_id` (required), `request_id`, `sales_rep_entity_ref`.
40
+ *
41
+ * Resolves to the queued request.
42
+ * @see https://docs.qubesync.com/api-reference/v2/sales-reps/update-sales-rep
43
+ */
44
+ update(connectionId: string, params: SalesRepUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
45
+ }
46
+
47
+ /**
48
+ * The params of `sales_rep.create`: Create sales rep.
49
+ */
50
+ export interface SalesRepCreateParams {
51
+ include_ret_element?: Array<"EditSequence" | "ExternalGUID" | "Initial" | "IsActive" | "ListID" | "OwnerID" | "SalesRepEntityRef" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
52
+ /**
53
+ * The initials of a sales representative’s name.
54
+ */
55
+ initial: string;
56
+ /**
57
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
58
+ */
59
+ is_active?: boolean;
60
+ /**
61
+ * 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`.
62
+ */
63
+ request_id?: string;
64
+ /**
65
+ * Refers to the sales representative’s full information on the Employee, Vendor, or OtherName list. In a request, if a `sales_rep_entity_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. Notice that you can’t supply a customer name here.
66
+ */
67
+ sales_rep_entity_ref: CurrencyRef;
68
+ }
69
+
70
+ /**
71
+ * The params of `sales_rep.query`: List sales reps.
72
+ */
73
+ export interface SalesRepQueryParams {
74
+ /**
75
+ * 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.
76
+ *
77
+ * 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.
78
+ */
79
+ active_status?: "ActiveOnly" | "All" | "InactiveOnly";
80
+ /**
81
+ * 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.
82
+ *
83
+ * 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.
84
+ *
85
+ * Format: date-time.
86
+ */
87
+ from_modified_date?: string;
88
+ /**
89
+ * `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
90
+ *
91
+ * 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.
92
+ */
93
+ full_name?: string[];
94
+ include_ret_element?: Array<"EditSequence" | "Initial" | "IsActive" | "ListID" | "SalesRepEntityRef" | "TimeCreated" | "TimeModified">;
95
+ /**
96
+ * `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`.
97
+ *
98
+ * 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.
99
+ */
100
+ list_id?: string[];
101
+ /**
102
+ * 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.
103
+ *
104
+ * 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.
105
+ *
106
+ * 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.
107
+ *
108
+ * Minimum 1.
109
+ */
110
+ max_returned?: number;
111
+ /**
112
+ * 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.
113
+ */
114
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
115
+ /**
116
+ * Filters according to the object’s Name.
117
+ *
118
+ * 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.
119
+ */
120
+ name_filter?: NameFilter;
121
+ /**
122
+ * Filters according to the object’s Name.
123
+ *
124
+ * 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.
125
+ */
126
+ name_range_filter?: NameRangeFilter;
127
+ /**
128
+ * 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`.
129
+ */
130
+ request_id?: string;
131
+ /**
132
+ * 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).
133
+ *
134
+ * 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.
135
+ *
136
+ * Format: date-time.
137
+ */
138
+ to_modified_date?: string;
139
+ }
140
+
141
+ /**
142
+ * The params of `sales_rep.update`: Update sales rep.
143
+ */
144
+ export interface SalesRepUpdateParams {
145
+ /**
146
+ * `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.
147
+ */
148
+ edit_sequence: string;
149
+ include_ret_element?: Array<"EditSequence" | "ExternalGUID" | "Initial" | "IsActive" | "ListID" | "OwnerID" | "SalesRepEntityRef" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
150
+ /**
151
+ * The initials of a sales representative’s name.
152
+ */
153
+ initial?: string;
154
+ /**
155
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
156
+ */
157
+ is_active?: boolean;
158
+ /**
159
+ * `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`.
160
+ */
161
+ list_id: string;
162
+ /**
163
+ * 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`.
164
+ */
165
+ request_id?: string;
166
+ /**
167
+ * Refers to the sales representative’s full information on the Employee, Vendor, or OtherName list. In a request, if a `sales_rep_entity_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. Notice that you can’t supply a customer name here.
168
+ */
169
+ sales_rep_entity_ref?: CurrencyRef;
170
+ }
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks sales rep operations. Types: sales_rep.d.ts. */
5
+ class SalesRep {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create sales rep.
15
+ * @param {string} connectionId
16
+ * @param {import("./sales_rep").SalesRepCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/sales-reps/create-sales-rep
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("sales_rep.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List sales reps.
27
+ * @param {string} connectionId
28
+ * @param {import("./sales_rep").SalesRepQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/sales-reps/list-sales-reps
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("sales_rep.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update sales rep.
39
+ * @param {string} connectionId
40
+ * @param {import("./sales_rep").SalesRepUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/sales-reps/update-sales-rep
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("sales_rep.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { SalesRep };
@@ -0,0 +1,194 @@
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, CurrencyRef, NameFilter, NameRangeFilter } from "./types";
5
+
6
+ /** QuickBooks sales tax code operations: `qube.salesTaxCode.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class SalesTaxCode {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create sales tax code: `POST /connections/{connection_id}/sales-tax-codes`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `desc`, `include_ret_element`, `is_active`, `is_taxable` (required), `item_purchase_tax_ref`, `item_sales_tax_ref`, `name` (required), `request_id`.
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/create-sales-tax-code
19
+ */
20
+ create(connectionId: string, params: SalesTaxCodeCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * List sales tax codes: `GET /connections/{connection_id}/sales-tax-codes`, 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/sales-tax-codes/list-sales-tax-codes
31
+ */
32
+ query(connectionId: string, params: SalesTaxCodeQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
33
+ /**
34
+ * Update sales tax code: `PUT /connections/{connection_id}/sales-tax-codes`, queued for QuickBooks.
35
+ *
36
+ * The answer comes to `webhookUrl` as one webhook.
37
+ * Params go in the JSON body.
38
+ *
39
+ * Fields: `desc`, `edit_sequence` (required), `include_ret_element`, `is_active`, `is_taxable`, `item_purchase_tax_ref`, `item_sales_tax_ref`, `list_id` (required), `name`, `request_id`.
40
+ *
41
+ * Resolves to the queued request.
42
+ * @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/update-sales-tax-code
43
+ */
44
+ update(connectionId: string, params: SalesTaxCodeUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
45
+ }
46
+
47
+ /**
48
+ * The params of `sales_tax_code.create`: Create sales tax code.
49
+ */
50
+ export interface SalesTaxCodeCreateParams {
51
+ /**
52
+ * Desc gives a longer explanation of Name.
53
+ */
54
+ desc?: string;
55
+ include_ret_element?: Array<"Desc" | "EditSequence" | "ExternalGUID" | "IsActive" | "IsTaxable" | "ItemPurchaseTaxRef" | "ItemSalesTaxRef" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
56
+ /**
57
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
58
+ */
59
+ is_active?: boolean;
60
+ /**
61
+ * Indicates whether this sales-tax code is tracking taxable sales. For any particular sales-tax code, `is_taxable` can’t be modified once the sales-tax code has been used in a transaction. If the “Do You Charge Sales Tax?” preference is set to Yes within QuickBooks, the default value of `is_taxable` is true.
62
+ */
63
+ is_taxable: boolean;
64
+ /**
65
+ * For future use with international versions of QuickBooks.
66
+ */
67
+ item_purchase_tax_ref?: CurrencyRef;
68
+ /**
69
+ * An ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead. If both `full_name` and `list_id` are provided for `item_sales_tax_ref`, `list_id` is used.
70
+ */
71
+ item_sales_tax_ref?: CurrencyRef;
72
+ /**
73
+ * Short name that will appear on sales forms to identify the tax status of an item. The Desc element gives a longer explanation of Name. Name must be unique, and it isn’t case-sensitive.
74
+ */
75
+ name: string;
76
+ /**
77
+ * 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`.
78
+ */
79
+ request_id?: string;
80
+ }
81
+
82
+ /**
83
+ * The params of `sales_tax_code.query`: List sales tax codes.
84
+ */
85
+ export interface SalesTaxCodeQueryParams {
86
+ /**
87
+ * 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.
88
+ *
89
+ * 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.
90
+ */
91
+ active_status?: "ActiveOnly" | "All" | "InactiveOnly";
92
+ /**
93
+ * 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.
94
+ *
95
+ * 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.
96
+ *
97
+ * Format: date-time.
98
+ */
99
+ from_modified_date?: string;
100
+ /**
101
+ * `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
102
+ *
103
+ * 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.
104
+ */
105
+ full_name?: string[];
106
+ include_ret_element?: Array<"Desc" | "EditSequence" | "IsActive" | "IsTaxable" | "ItemPurchaseTaxRef" | "ItemSalesTaxRef" | "ListID" | "Name" | "TimeCreated" | "TimeModified">;
107
+ /**
108
+ * `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`.
109
+ *
110
+ * 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.
111
+ */
112
+ list_id?: string[];
113
+ /**
114
+ * 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.
115
+ *
116
+ * 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.
117
+ *
118
+ * 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.
119
+ *
120
+ * Minimum 1.
121
+ */
122
+ max_returned?: number;
123
+ /**
124
+ * 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.
125
+ */
126
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
127
+ /**
128
+ * Filters according to the object’s Name.
129
+ *
130
+ * 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.
131
+ */
132
+ name_filter?: NameFilter;
133
+ /**
134
+ * Filters according to the object’s Name.
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
+ name_range_filter?: NameRangeFilter;
139
+ /**
140
+ * 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`.
141
+ */
142
+ request_id?: string;
143
+ /**
144
+ * 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).
145
+ *
146
+ * 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.
147
+ *
148
+ * Format: date-time.
149
+ */
150
+ to_modified_date?: string;
151
+ }
152
+
153
+ /**
154
+ * The params of `sales_tax_code.update`: Update sales tax code.
155
+ */
156
+ export interface SalesTaxCodeUpdateParams {
157
+ /**
158
+ * Desc gives a longer explanation of Name.
159
+ */
160
+ desc?: string;
161
+ /**
162
+ * `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.
163
+ */
164
+ edit_sequence: string;
165
+ include_ret_element?: Array<"Desc" | "EditSequence" | "ExternalGUID" | "IsActive" | "IsTaxable" | "ItemPurchaseTaxRef" | "ItemSalesTaxRef" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
166
+ /**
167
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
168
+ */
169
+ is_active?: boolean;
170
+ /**
171
+ * Indicates whether this sales-tax code is tracking taxable sales. For any particular sales-tax code, `is_taxable` can’t be modified once the sales-tax code has been used in a transaction. If the “Do You Charge Sales Tax?” preference is set to Yes within QuickBooks, the default value of `is_taxable` is true.
172
+ */
173
+ is_taxable?: boolean;
174
+ /**
175
+ * For future use with international versions of QuickBooks.
176
+ */
177
+ item_purchase_tax_ref?: CurrencyRef;
178
+ /**
179
+ * An ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead. If both `full_name` and `list_id` are provided for `item_sales_tax_ref`, `list_id` is used.
180
+ */
181
+ item_sales_tax_ref?: CurrencyRef;
182
+ /**
183
+ * `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`.
184
+ */
185
+ list_id: string;
186
+ /**
187
+ * Short name that will appear on sales forms to identify the tax status of an item. The Desc element gives a longer explanation of Name. Name must be unique, and it isn’t case-sensitive.
188
+ */
189
+ name?: string;
190
+ /**
191
+ * 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`.
192
+ */
193
+ request_id?: string;
194
+ }
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks sales tax code operations. Types: sales_tax_code.d.ts. */
5
+ class SalesTaxCode {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create sales tax code.
15
+ * @param {string} connectionId
16
+ * @param {import("./sales_tax_code").SalesTaxCodeCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/create-sales-tax-code
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("sales_tax_code.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List sales tax codes.
27
+ * @param {string} connectionId
28
+ * @param {import("./sales_tax_code").SalesTaxCodeQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/list-sales-tax-codes
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("sales_tax_code.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update sales tax code.
39
+ * @param {string} connectionId
40
+ * @param {import("./sales_tax_code").SalesTaxCodeUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/update-sales-tax-code
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("sales_tax_code.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { SalesTaxCode };
@@ -0,0 +1,42 @@
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 } from "./types";
5
+
6
+ /** QuickBooks sales tax payable operations: `qube.salesTaxPayable.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class SalesTaxPayable {
8
+ constructor(client: Client);
9
+ /**
10
+ * List sales tax payables: `GET /connections/{connection_id}/sales-tax-payables`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the query string.
14
+ *
15
+ * Fields: `as_of_date`, `include_ret_element`, `meta_data`, `request_id`.
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/sales-tax-payables/list-sales-tax-payables
19
+ */
20
+ query(connectionId: string, params: SalesTaxPayableQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
21
+ }
22
+
23
+ /**
24
+ * The params of `sales_tax_payable.query`: List sales tax payables.
25
+ */
26
+ export interface SalesTaxPayableQueryParams {
27
+ /**
28
+ * The date when the exchange rate was last changed.
29
+ *
30
+ * Format: date.
31
+ */
32
+ as_of_date?: string;
33
+ include_ret_element?: Array<"Amount" | "PayeeEntityRef" | "SalesTaxPayableLineRet">;
34
+ /**
35
+ * 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.
36
+ */
37
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
38
+ /**
39
+ * 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`.
40
+ */
41
+ request_id?: string;
42
+ }
@@ -0,0 +1,26 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks sales tax payable operations. Types: sales_tax_payable.d.ts. */
5
+ class SalesTaxPayable {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * List sales tax payables.
15
+ * @param {string} connectionId
16
+ * @param {import("./sales_tax_payable").SalesTaxPayableQueryParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/sales-tax-payables/list-sales-tax-payables
20
+ */
21
+ query(connectionId, params, options) {
22
+ return this.#client.queue("sales_tax_payable.query", connectionId, params, options);
23
+ }
24
+ }
25
+
26
+ module.exports = { SalesTaxPayable };