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,197 @@
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 } from "./types";
5
+
6
+ /** QuickBooks data ext operations: `qube.dataExt.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class DataExt {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create data ext: `POST /connections/{connection_id}/data-exts`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `data_ext_name` (required), `data_ext_value` (required), `list_data_ext_type`, `list_obj_ref`, `other_data_ext_type`, `owner_id` (required), `request_id`, `txn_data_ext_type`, `txn_id`, `txn_line_id`.
16
+ *
17
+ * Give exactly one of: (`list_data_ext_type`, `list_obj_ref`), or (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`.
18
+ *
19
+ * Resolves to the queued request.
20
+ * @see https://docs.qubesync.com/api-reference/v2/data-exts/create-data-ext
21
+ */
22
+ create(connectionId: string, params: DataExtCreateParams, options: OperationOptions): Promise<QueuedRequest>;
23
+ /**
24
+ * Delete data ext: `DELETE /connections/{connection_id}/data-exts`, queued for QuickBooks.
25
+ *
26
+ * The answer comes to `webhookUrl` as one webhook.
27
+ * Params go in the JSON body.
28
+ *
29
+ * Fields: `data_ext_del` (required), `request_id`.
30
+ *
31
+ * Resolves to the queued request.
32
+ * @see https://docs.qubesync.com/api-reference/v2/data-exts/delete-data-ext
33
+ */
34
+ delete(connectionId: string, params: DataExtDeleteParams, options: OperationOptions): Promise<QueuedRequest>;
35
+ /**
36
+ * Update data ext: `PUT /connections/{connection_id}/data-exts`, queued for QuickBooks.
37
+ *
38
+ * The answer comes to `webhookUrl` as one webhook.
39
+ * Params go in the JSON body.
40
+ *
41
+ * Fields: `data_ext_name` (required), `data_ext_value` (required), `list_data_ext_type`, `list_obj_ref`, `other_data_ext_type`, `owner_id` (required), `request_id`, `txn_data_ext_type`, `txn_id`, `txn_line_id`.
42
+ *
43
+ * Give exactly one of: (`list_data_ext_type`, `list_obj_ref`), or (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`.
44
+ *
45
+ * Resolves to the queued request.
46
+ * @see https://docs.qubesync.com/api-reference/v2/data-exts/update-data-ext
47
+ */
48
+ update(connectionId: string, params: DataExtUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
49
+ }
50
+
51
+ /**
52
+ * The params of `data_ext.create`: Create data ext.
53
+ *
54
+ * Give exactly one of: (`list_data_ext_type`, `list_obj_ref`), or (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`.
55
+ */
56
+ export interface DataExtCreateParams {
57
+ /**
58
+ * The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields.
59
+ */
60
+ data_ext_name: string;
61
+ /**
62
+ * The data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension. For example, if `data_ext_type` is STR255TYPE, the maximum length of `data_ext_value` is 255 characters. If `data_ext_type` is STR1024TYPE, the maximum size of `data_ext_value` is 1KB.
63
+ */
64
+ data_ext_value: string;
65
+ /**
66
+ * The type of list object (e.g. Customer) that this data extension is attached to.
67
+ */
68
+ list_data_ext_type?: "Account" | "Customer" | "Employee" | "Item" | "OtherName" | "Vendor";
69
+ /**
70
+ * Refers to a list object. In a DataExtAdd request, the list object ref must be the same type as the type specified in `list_data_ext_type`. If a `list_obj_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
71
+ */
72
+ list_obj_ref?: CurrencyRef;
73
+ /**
74
+ * Not supported.
75
+ */
76
+ other_data_ext_type?: "Company";
77
+ /**
78
+ * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
79
+ */
80
+ owner_id: string;
81
+ /**
82
+ * 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`.
83
+ */
84
+ request_id?: string;
85
+ /**
86
+ * The type of transaction that the data extension belongs to.
87
+ */
88
+ txn_data_ext_type?: "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "VendorCredit";
89
+ /**
90
+ * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
91
+ */
92
+ txn_id?: string;
93
+ /**
94
+ * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
95
+ */
96
+ txn_line_id?: string;
97
+ }
98
+
99
+ /**
100
+ * The params of `data_ext.delete`: Delete data ext.
101
+ */
102
+ export interface DataExtDeleteParams {
103
+ /**
104
+ * DataExt The DataExtAdd request writes data to the specified data extension for the specified object. Before you can use a DataExtAdd message to populate a data-extension field with data, the field must be defined, either through the SDK via a DataExtDefAdd request or via the QuickBooks UI by the interactive user.
105
+ */
106
+ data_ext_del: DataExtDel;
107
+ /**
108
+ * 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`.
109
+ */
110
+ request_id?: string;
111
+ }
112
+
113
+ /**
114
+ * The params of `data_ext.update`: Update data ext.
115
+ *
116
+ * Give exactly one of: (`list_data_ext_type`, `list_obj_ref`), or (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`.
117
+ */
118
+ export interface DataExtUpdateParams {
119
+ /**
120
+ * The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields.
121
+ */
122
+ data_ext_name: string;
123
+ /**
124
+ * The data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension. For example, if `data_ext_type` is STR255TYPE, the maximum length of `data_ext_value` is 255 characters. If `data_ext_type` is STR1024TYPE, the maximum size of `data_ext_value` is 1KB.
125
+ */
126
+ data_ext_value: string;
127
+ /**
128
+ * The type of list object (e.g. Customer) that this data extension is attached to.
129
+ */
130
+ list_data_ext_type?: "Account" | "Customer" | "Employee" | "Item" | "OtherName" | "Vendor";
131
+ /**
132
+ * Refers to a list object. In a DataExtAdd request, the list object ref must be the same type as the type specified in `list_data_ext_type`. If a `list_obj_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
133
+ */
134
+ list_obj_ref?: CurrencyRef;
135
+ /**
136
+ * Not supported.
137
+ */
138
+ other_data_ext_type?: "Company";
139
+ /**
140
+ * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
141
+ */
142
+ owner_id: string;
143
+ /**
144
+ * 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`.
145
+ */
146
+ request_id?: string;
147
+ /**
148
+ * The type of transaction that the data extension belongs to.
149
+ */
150
+ txn_data_ext_type?: "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "VendorCredit";
151
+ /**
152
+ * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
153
+ */
154
+ txn_id?: string;
155
+ /**
156
+ * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
157
+ */
158
+ txn_line_id?: string;
159
+ }
160
+
161
+ /**
162
+ * Give exactly one of: (`list_data_ext_type`, `list_obj_ref`), or (`txn_data_ext_type`, `txn_id`, `txn_line_id`), or `other_data_ext_type`.
163
+ */
164
+ export interface DataExtDel {
165
+ /**
166
+ * The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields.
167
+ */
168
+ data_ext_name: string;
169
+ /**
170
+ * The type of list object (e.g. Customer) that this data extension is attached to.
171
+ */
172
+ list_data_ext_type?: "Account" | "Customer" | "Employee" | "Item" | "OtherName" | "Vendor";
173
+ /**
174
+ * Refers to a list object. In a DataExtAdd request, the list object ref must be the same type as the type specified in `list_data_ext_type`. If a `list_obj_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
175
+ */
176
+ list_obj_ref?: CurrencyRef;
177
+ /**
178
+ * Not supported.
179
+ */
180
+ other_data_ext_type?: "Company";
181
+ /**
182
+ * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
183
+ */
184
+ owner_id: string;
185
+ /**
186
+ * The type of transaction that the data extension belongs to.
187
+ */
188
+ txn_data_ext_type?: "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "VendorCredit";
189
+ /**
190
+ * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
191
+ */
192
+ txn_id?: string;
193
+ /**
194
+ * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
195
+ */
196
+ txn_line_id?: string;
197
+ }
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks data ext operations. Types: data_ext.d.ts. */
5
+ class DataExt {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create data ext.
15
+ * @param {string} connectionId
16
+ * @param {import("./data_ext").DataExtCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/data-exts/create-data-ext
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("data_ext.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * Delete data ext.
27
+ * @param {string} connectionId
28
+ * @param {import("./data_ext").DataExtDeleteParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/data-exts/delete-data-ext
32
+ */
33
+ delete(connectionId, params, options) {
34
+ return this.#client.queue("data_ext.delete", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update data ext.
39
+ * @param {string} connectionId
40
+ * @param {import("./data_ext").DataExtUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/data-exts/update-data-ext
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("data_ext.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { DataExt };
@@ -0,0 +1,173 @@
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 data ext def operations: `qube.dataExtDef.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class DataExtDef {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create data ext def: `POST /connections/{connection_id}/data-ext-defs`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `assign_to_object`, `data_ext_format_string`, `data_ext_list_require`, `data_ext_name` (required), `data_ext_txn_require`, `data_ext_type` (required), `include_ret_element`, `owner_id` (required), `request_id`.
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/create-data-ext-def
19
+ */
20
+ create(connectionId: string, params: DataExtDefCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * Delete data ext def: `DELETE /connections/{connection_id}/data-ext-defs`, queued for QuickBooks.
23
+ *
24
+ * The answer comes to `webhookUrl` as one webhook.
25
+ * Params go in the JSON body.
26
+ *
27
+ * Fields: `data_ext_name` (required), `owner_id` (required), `request_id`.
28
+ *
29
+ * Resolves to the queued request.
30
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/delete-data-ext-def
31
+ */
32
+ delete(connectionId: string, params: DataExtDefDeleteParams, options: OperationOptions): Promise<QueuedRequest>;
33
+ /**
34
+ * List data ext defs: `GET /connections/{connection_id}/data-ext-defs`, queued for QuickBooks.
35
+ *
36
+ * The answer comes to `webhookUrl` as one webhook.
37
+ * Params go in the query string.
38
+ *
39
+ * Fields: `assign_to_object`, `include_ret_element`, `meta_data`, `owner_id`, `request_id`.
40
+ *
41
+ * Resolves to the queued request.
42
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/list-data-ext-defs
43
+ */
44
+ query(connectionId: string, params: DataExtDefQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
45
+ /**
46
+ * Update data ext def: `PUT /connections/{connection_id}/data-ext-defs`, queued for QuickBooks.
47
+ *
48
+ * The answer comes to `webhookUrl` as one webhook.
49
+ * Params go in the JSON body.
50
+ *
51
+ * Fields: `assign_to_object`, `data_ext_format_string`, `data_ext_list_require`, `data_ext_name` (required), `data_ext_new_name`, `data_ext_txn_require`, `include_ret_element`, `owner_id` (required), `remove_from_object`, `request_id`.
52
+ *
53
+ * Resolves to the queued request.
54
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/update-data-ext-def
55
+ */
56
+ update(connectionId: string, params: DataExtDefUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
57
+ }
58
+
59
+ /**
60
+ * The params of `data_ext_def.create`: Create data ext def.
61
+ */
62
+ export interface DataExtDefCreateParams {
63
+ assign_to_object?: Array<"ARRefundCreditCard" | "Account" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "Company" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Customer" | "Deposit" | "Employee" | "Estimate" | "InventoryAdjustment" | "Invoice" | "Item" | "ItemReceipt" | "JournalEntry" | "OtherName" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Vendor" | "VendorCredit">;
64
+ /**
65
+ * The string format required for the data extension.
66
+ */
67
+ data_ext_format_string?: string;
68
+ /**
69
+ * If `data_ext_list_require` is true, this data extension field is required to be entered in lists. The default value is false.
70
+ */
71
+ data_ext_list_require?: boolean;
72
+ /**
73
+ * The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields.
74
+ */
75
+ data_ext_name: string;
76
+ /**
77
+ * If `data_ext_txn_require` is true, this data extension field is required to be entered in transaction. The default value is false.
78
+ */
79
+ data_ext_txn_require?: boolean;
80
+ /**
81
+ * The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, `data_ext_type` must be detSTR255TYPE.
82
+ */
83
+ data_ext_type: "AMTTYPE" | "DATETIMETYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STR1024TYPE" | "STR255TYPE";
84
+ include_ret_element?: Array<"AssignToObject" | "DataExtFormatString" | "DataExtID" | "DataExtListRequire" | "DataExtName" | "DataExtTxnRequire" | "DataExtType" | "EditSequence" | "ExternalGUID" | "ListID" | "OwnerID" | "TxnID" | "TxnNumber">;
85
+ /**
86
+ * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
87
+ */
88
+ owner_id: string;
89
+ /**
90
+ * 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`.
91
+ */
92
+ request_id?: string;
93
+ }
94
+
95
+ /**
96
+ * The params of `data_ext_def.delete`: Delete data ext def.
97
+ */
98
+ export interface DataExtDefDeleteParams {
99
+ /**
100
+ * The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields.
101
+ */
102
+ data_ext_name: string;
103
+ /**
104
+ * `owner_id` identifies the extension owner. `owner_id` 0 means a public custom field visible in the QuickBooks UI. A GUID means a private app extension that is not shown in the UI. `owner_id` matching is case-insensitive. To share private extensions across apps, both apps must use the same `owner_id` and `data_ext_name`.
105
+ */
106
+ owner_id: string;
107
+ /**
108
+ * 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`.
109
+ */
110
+ request_id?: string;
111
+ }
112
+
113
+ /**
114
+ * The params of `data_ext_def.query`: List data ext defs.
115
+ */
116
+ export interface DataExtDefQueryParams {
117
+ /**
118
+ * Choose at most one of: `owner_id`, or `assign_to_object`.
119
+ */
120
+ assign_to_object?: Array<"ARRefundCreditCard" | "Account" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "Company" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Customer" | "Deposit" | "Employee" | "Estimate" | "InventoryAdjustment" | "Invoice" | "Item" | "ItemReceipt" | "JournalEntry" | "OtherName" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Vendor" | "VendorCredit">;
121
+ include_ret_element?: Array<"AssignToObject" | "DataExtFormatString" | "DataExtID" | "DataExtListRequire" | "DataExtName" | "DataExtTxnRequire" | "DataExtType" | "OwnerID">;
122
+ /**
123
+ * 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.
124
+ */
125
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
126
+ /**
127
+ * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
128
+ *
129
+ * Choose at most one of: `owner_id`, or `assign_to_object`.
130
+ */
131
+ owner_id?: string[];
132
+ /**
133
+ * 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`.
134
+ */
135
+ request_id?: string;
136
+ }
137
+
138
+ /**
139
+ * The params of `data_ext_def.update`: Update data ext def.
140
+ */
141
+ export interface DataExtDefUpdateParams {
142
+ assign_to_object?: Array<"ARRefundCreditCard" | "Account" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "Company" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Customer" | "Deposit" | "Employee" | "Estimate" | "InventoryAdjustment" | "Invoice" | "Item" | "ItemReceipt" | "JournalEntry" | "OtherName" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Vendor" | "VendorCredit">;
143
+ /**
144
+ * The string format required for the data extension.
145
+ */
146
+ data_ext_format_string?: string;
147
+ /**
148
+ * If `data_ext_list_require` is true, this data extension field is required to be entered in lists. The default value is false.
149
+ */
150
+ data_ext_list_require?: boolean;
151
+ /**
152
+ * The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields.
153
+ */
154
+ data_ext_name: string;
155
+ /**
156
+ * The new name for this field. Note that in the case of custom fields, `data_ext_new_name` can run into name conflicts, because the name space of custom fields (data extensions with an `owner_id` of 0) is shared by all applications.
157
+ */
158
+ data_ext_new_name?: string;
159
+ /**
160
+ * If `data_ext_txn_require` is true, this data extension field is required to be entered in transaction. The default value is false.
161
+ */
162
+ data_ext_txn_require?: boolean;
163
+ include_ret_element?: Array<"AssignToObject" | "DataExtFormatString" | "DataExtID" | "DataExtListRequire" | "DataExtName" | "DataExtTxnRequire" | "DataExtType" | "EditSequence" | "ExternalGUID" | "ListID" | "OwnerID" | "TxnID" | "TxnNumber">;
164
+ /**
165
+ * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
166
+ */
167
+ owner_id: string;
168
+ remove_from_object?: Array<"ARRefundCreditCard" | "Account" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "Company" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Customer" | "Deposit" | "Employee" | "Estimate" | "InventoryAdjustment" | "Invoice" | "Item" | "ItemReceipt" | "JournalEntry" | "OtherName" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Vendor" | "VendorCredit">;
169
+ /**
170
+ * 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`.
171
+ */
172
+ request_id?: string;
173
+ }
@@ -0,0 +1,62 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks data ext def operations. Types: data_ext_def.d.ts. */
5
+ class DataExtDef {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create data ext def.
15
+ * @param {string} connectionId
16
+ * @param {import("./data_ext_def").DataExtDefCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/create-data-ext-def
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("data_ext_def.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * Delete data ext def.
27
+ * @param {string} connectionId
28
+ * @param {import("./data_ext_def").DataExtDefDeleteParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/delete-data-ext-def
32
+ */
33
+ delete(connectionId, params, options) {
34
+ return this.#client.queue("data_ext_def.delete", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * List data ext defs.
39
+ * @param {string} connectionId
40
+ * @param {import("./data_ext_def").DataExtDefQueryParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/list-data-ext-defs
44
+ */
45
+ query(connectionId, params, options) {
46
+ return this.#client.queue("data_ext_def.query", connectionId, params, options);
47
+ }
48
+
49
+ /**
50
+ * Update data ext def.
51
+ * @param {string} connectionId
52
+ * @param {import("./data_ext_def").DataExtDefUpdateParams} params
53
+ * @param {import("./types").OperationOptions} options
54
+ * @returns {Promise<import("./types").QueuedRequest>}
55
+ * @see https://docs.qubesync.com/api-reference/v2/data-ext-defs/update-data-ext-def
56
+ */
57
+ update(connectionId, params, options) {
58
+ return this.#client.queue("data_ext_def.update", connectionId, params, options);
59
+ }
60
+ }
61
+
62
+ module.exports = { DataExtDef };
@@ -0,0 +1,141 @@
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 date driven terms operations: `qube.dateDrivenTerms.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class DateDrivenTerms {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create date driven terms: `POST /connections/{connection_id}/date-driven-terms`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `day_of_month_due` (required), `discount_day_of_month`, `discount_pct`, `due_next_month_days`, `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/date-driven-terms/create-date-driven-terms
19
+ */
20
+ create(connectionId: string, params: DateDrivenTermsCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * List date driven terms: `GET /connections/{connection_id}/date-driven-terms`, 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/date-driven-terms/list-date-driven-terms
31
+ */
32
+ query(connectionId: string, params: DateDrivenTermsQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
33
+ }
34
+
35
+ /**
36
+ * The params of `date_driven_terms.create`: Create date driven terms.
37
+ */
38
+ export interface DateDrivenTermsCreateParams {
39
+ /**
40
+ * The day of the month when full payment is due with no discount.
41
+ *
42
+ * Minimum 1. Maximum 31.
43
+ */
44
+ day_of_month_due: number;
45
+ /**
46
+ * If the payment is made by this day of the month, then `discount_pct` applies.
47
+ *
48
+ * Minimum 1. Maximum 31.
49
+ */
50
+ discount_day_of_month?: number;
51
+ /**
52
+ * If payment is received by `discount_day_of_month`, then this discount will apply to the payment. `discount_pct` must be between 0 and 100.
53
+ */
54
+ discount_pct?: number;
55
+ /**
56
+ * Handles cases when an invoice or bill is issued close to its due date. If the invoice or bill is issued within this many days of the due date, payment isn’t due until the following month. For example, with a `day_of_month_due` of 15 and a `due_next_month_days` of 2, an invoice issued on May 13th wouldn’t be due until June 15th.
57
+ */
58
+ due_next_month_days?: number;
59
+ include_ret_element?: Array<"DayOfMonthDue" | "DiscountDayOfMonth" | "DiscountPct" | "DueNextMonthDays" | "EditSequence" | "ExternalGUID" | "IsActive" | "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 `date_driven_terms.query`: List date driven terms.
76
+ */
77
+ export interface DateDrivenTermsQueryParams {
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<"DayOfMonthDue" | "DiscountDayOfMonth" | "DiscountPct" | "DueNextMonthDays" | "EditSequence" | "IsActive" | "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
+ }