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,38 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks date driven terms operations. Types: date_driven_terms.d.ts. */
5
+ class DateDrivenTerms {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create date driven terms.
15
+ * @param {string} connectionId
16
+ * @param {import("./date_driven_terms").DateDrivenTermsCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/date-driven-terms/create-date-driven-terms
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("date_driven_terms.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List date driven terms.
27
+ * @param {string} connectionId
28
+ * @param {import("./date_driven_terms").DateDrivenTermsQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/date-driven-terms/list-date-driven-terms
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("date_driven_terms.query", connectionId, params, options);
35
+ }
36
+ }
37
+
38
+ module.exports = { DateDrivenTerms };
@@ -0,0 +1,402 @@
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, AccountFilter, CurrencyFilter, CurrencyRef, ModifiedDateRangeFilter, TxnDateRangeFilter } from "./types";
5
+
6
+ /** QuickBooks deposit operations: `qube.deposit.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class Deposit {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create deposit: `POST /connections/{connection_id}/deposits`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `cash_back_info_add`, `currency_ref`, `def_macro`, `deposit_line_add`, `deposit_to_account_ref` (required), `exchange_rate`, `external_guid`, `include_ret_element`, `memo`, `request_id`, `txn_date`.
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/deposits/create-deposit
19
+ */
20
+ create(connectionId: string, params: DepositCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * List deposits: `GET /connections/{connection_id}/deposits`, queued for QuickBooks.
23
+ *
24
+ * QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
25
+ * Params go in the query string.
26
+ *
27
+ * Fields: `account_filter`, `currency_filter`, `entity_filter`, `include_line_items`, `include_ret_element`, `iterator`, `max_returned`, `meta_data`, `modified_date_range_filter`, `owner_id`, `request_id`, `txn_date_range_filter`, `txn_id`.
28
+ *
29
+ * Resolves to the queued request.
30
+ * @see https://docs.qubesync.com/api-reference/v2/deposits/list-deposits
31
+ */
32
+ query(connectionId: string, params: DepositQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
33
+ /**
34
+ * Update deposit: `PUT /connections/{connection_id}/deposits`, queued for QuickBooks.
35
+ *
36
+ * The answer comes to `webhookUrl` as one webhook.
37
+ * Params go in the JSON body.
38
+ *
39
+ * Fields: `cash_back_info_mod`, `currency_ref`, `deposit_line_mod`, `deposit_to_account_ref`, `edit_sequence` (required), `exchange_rate`, `include_ret_element`, `memo`, `request_id`, `txn_date`, `txn_id` (required).
40
+ *
41
+ * Resolves to the queued request.
42
+ * @see https://docs.qubesync.com/api-reference/v2/deposits/update-deposit
43
+ */
44
+ update(connectionId: string, params: DepositUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
45
+ }
46
+
47
+ /**
48
+ * The params of `deposit.create`: Create deposit.
49
+ */
50
+ export interface DepositCreateParams {
51
+ /**
52
+ * This aggregate is included if there is cash back from this deposit. `account_ref` indicates where the cash back Amount is going (for example, into a petty cash account).
53
+ */
54
+ cash_back_info_add?: CashBackInfoAdd;
55
+ /**
56
+ * A currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow.
57
+ */
58
+ currency_ref?: CurrencyRef;
59
+ /**
60
+ * `def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
61
+ */
62
+ def_macro?: string;
63
+ deposit_line_add?: DepositLineAdd[];
64
+ /**
65
+ * Refers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this isn’t included in the request. In a request, if a `deposit_to_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
66
+ */
67
+ deposit_to_account_ref: CurrencyRef;
68
+ /**
69
+ * `exchange_rate` is the rate from this currency to the company’s home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks does not provide rates through the SDK. If your home currency is USD and internet access is available, rates can be downloaded in the QuickBooks UI via Lists > Currency > Activities > Download Latest Exchange Rates.
70
+ */
71
+ exchange_rate?: number;
72
+ /**
73
+ * Allows for the attachment of a user defined GUID value.
74
+ */
75
+ external_guid?: string;
76
+ include_ret_element?: Array<"CashBackInfoRet" | "CurrencyRef" | "DataExtRet" | "DepositLineRet" | "DepositToAccountRef" | "DepositTotal" | "DepositTotalInHomeCurrency" | "EditSequence" | "ExchangeRate" | "ExternalGUID" | "ListID" | "Memo" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
77
+ /**
78
+ * Additional information.
79
+ */
80
+ memo?: 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 date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
87
+ *
88
+ * Format: date.
89
+ */
90
+ txn_date?: string;
91
+ }
92
+
93
+ /**
94
+ * The params of `deposit.query`: List deposits.
95
+ */
96
+ export interface DepositQueryParams {
97
+ /**
98
+ * Filters according to the account name or `list_id`. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for `full_name` and get the account you’re looking for. But if numbers have been used as account names, confusion could arise.
99
+ *
100
+ * Choose at most one of: `txn_id`, or the set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
101
+ */
102
+ account_filter?: AccountFilter;
103
+ /**
104
+ * Filters by the specified currency.
105
+ *
106
+ * Choose at most one of: `txn_id`, or the set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
107
+ */
108
+ currency_filter?: CurrencyFilter;
109
+ /**
110
+ * An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or Other Names list. You can use an EntityQuery request to get information about all the entities that are set up in the QuickBooks file. In an ARRefundCreditCard query, this must be a customer/customer job.
111
+ *
112
+ * Choose at most one of: `txn_id`, or the set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
113
+ */
114
+ entity_filter?: AccountFilter;
115
+ /**
116
+ * This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set `include_line_items` to true to include line items in the response if you don’t mind getting a larger result.
117
+ */
118
+ include_line_items?: boolean;
119
+ include_ret_element?: Array<"CashBackInfoRet" | "CurrencyRef" | "DataExtRet" | "DepositLineRet" | "DepositToAccountRef" | "DepositTotal" | "DepositTotalInHomeCurrency" | "EditSequence" | "ExchangeRate" | "ExternalGUID" | "Memo" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
120
+ /**
121
+ * Page through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records (25 with `include_line_items`); send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `txn_id` every match comes back in one answer, so leave `iterator` out.
122
+ */
123
+ iterator?: boolean;
124
+ /**
125
+ * 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.
126
+ *
127
+ * The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched.
128
+ *
129
+ * Choose at most one of: `txn_id`, or the set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
130
+ *
131
+ * Minimum 1.
132
+ */
133
+ max_returned?: number;
134
+ /**
135
+ * 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.
136
+ */
137
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
138
+ /**
139
+ * Filters according to the dates when transactions were last modified. The `modified_date_range_filter` aggregate isn’t required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `from_modified_date` and `to_modified_date` fields wasn’t supported in qbXML version 1.0 or 1.1.
140
+ *
141
+ * Choose at most one of: `txn_id`, or the set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
142
+ */
143
+ modified_date_range_filter?: ModifiedDateRangeFilter;
144
+ /**
145
+ * `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.
146
+ */
147
+ owner_id?: string[];
148
+ /**
149
+ * 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`.
150
+ */
151
+ request_id?: string;
152
+ /**
153
+ * Filters according to the original transaction dates.
154
+ *
155
+ * Choose at most one of: `txn_id`, or the set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
156
+ */
157
+ txn_date_range_filter?: TxnDateRangeFilter;
158
+ /**
159
+ * `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.
160
+ *
161
+ * Choose at most one of: `txn_id`, or the set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
162
+ */
163
+ txn_id?: string[];
164
+ }
165
+
166
+ /**
167
+ * The params of `deposit.update`: Update deposit.
168
+ */
169
+ export interface DepositUpdateParams {
170
+ /**
171
+ * This aggregate is included if there is cash back from this deposit. `account_ref` indicates where the cash back Amount is going (for example, into a petty cash account).
172
+ */
173
+ cash_back_info_mod?: CashBackInfoMod;
174
+ /**
175
+ * A currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow.
176
+ */
177
+ currency_ref?: CurrencyRef;
178
+ deposit_line_mod?: DepositLineMod[];
179
+ /**
180
+ * Refers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this isn’t included in the request. In a request, if a `deposit_to_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
181
+ */
182
+ deposit_to_account_ref?: CurrencyRef;
183
+ /**
184
+ * `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.
185
+ */
186
+ edit_sequence: string;
187
+ /**
188
+ * `exchange_rate` is the rate from this currency to the company’s home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks does not provide rates through the SDK. If your home currency is USD and internet access is available, rates can be downloaded in the QuickBooks UI via Lists > Currency > Activities > Download Latest Exchange Rates.
189
+ */
190
+ exchange_rate?: number;
191
+ include_ret_element?: Array<"CashBackInfoRet" | "CurrencyRef" | "DataExtRet" | "DepositLineRet" | "DepositToAccountRef" | "DepositTotal" | "DepositTotalInHomeCurrency" | "EditSequence" | "ExchangeRate" | "ExternalGUID" | "ListID" | "Memo" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnNumber">;
192
+ /**
193
+ * Additional information.
194
+ */
195
+ memo?: string;
196
+ /**
197
+ * 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`.
198
+ */
199
+ request_id?: string;
200
+ /**
201
+ * The date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
202
+ *
203
+ * Format: date.
204
+ */
205
+ txn_date?: string;
206
+ /**
207
+ * `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.
208
+ */
209
+ txn_id: string;
210
+ }
211
+
212
+ export interface CashBackInfoAdd {
213
+ /**
214
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
215
+ */
216
+ account_ref: CurrencyRef;
217
+ /**
218
+ * A monetary amount.
219
+ */
220
+ amount?: number;
221
+ /**
222
+ * `def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
223
+ */
224
+ def_macro?: string;
225
+ /**
226
+ * Additional information.
227
+ */
228
+ memo?: string;
229
+ }
230
+
231
+ export interface CashBackInfoMod {
232
+ /**
233
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
234
+ */
235
+ account_ref?: CurrencyRef;
236
+ /**
237
+ * A monetary amount.
238
+ */
239
+ amount?: number;
240
+ /**
241
+ * Additional information.
242
+ */
243
+ memo?: string;
244
+ }
245
+
246
+ export interface DepositLineAdd {
247
+ /**
248
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
249
+ *
250
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
251
+ */
252
+ account_ref?: CurrencyRef;
253
+ /**
254
+ * A monetary amount.
255
+ *
256
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
257
+ */
258
+ amount?: number;
259
+ /**
260
+ * The check number of a check that a QuickBooks user writes or receives from someone else.
261
+ *
262
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
263
+ */
264
+ check_number?: string;
265
+ /**
266
+ * Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
267
+ *
268
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
269
+ */
270
+ class_ref?: CurrencyRef;
271
+ /**
272
+ * `def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
273
+ */
274
+ def_macro?: string;
275
+ /**
276
+ * A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a BillToPayQuery message, `entity_ref` refers to the vendor name. In JournalCreditLine and JournalDebitLine messages for A/R accounts, `entity_ref` must refer to a customer, or else the transaction won’t be recorded.
277
+ *
278
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
279
+ */
280
+ entity_ref?: CurrencyRef;
281
+ /**
282
+ * Additional information.
283
+ *
284
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
285
+ */
286
+ memo?: string;
287
+ /**
288
+ * Deposit line check number.
289
+ *
290
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
291
+ */
292
+ override_check_number?: string;
293
+ /**
294
+ * Deposit line class reference.
295
+ *
296
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
297
+ */
298
+ override_class_ref?: CurrencyRef;
299
+ /**
300
+ * Depost line memo additional information.
301
+ *
302
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
303
+ */
304
+ override_memo?: string;
305
+ /**
306
+ * `payment_method_ref` identifies how a payment is made (for example, cash, check, or card type). If both `full_name` and `list_id` are provided, `full_name` is ignored.
307
+ *
308
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
309
+ */
310
+ payment_method_ref?: CurrencyRef;
311
+ /**
312
+ * For the `payment_txn_id`, use either of these two values:A `txn_id` value exactly as it is returned by the ReceivePaymentToDepositQuery request, or A `txn_id` value exactly as it is returned in a ReceivePaymentAdd response.
313
+ *
314
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
315
+ */
316
+ payment_txn_id?: string;
317
+ /**
318
+ * For the `payment_txn_line_id`, use a `txn_line_id` value exactly as it has been returned by the ReceivePaymentToDepositQuery request. If you don’t include a `payment_txn_line_id` and include a `payment_txn_id` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited.
319
+ *
320
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
321
+ */
322
+ payment_txn_line_id?: string;
323
+ }
324
+
325
+ export interface DepositLineMod {
326
+ /**
327
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
328
+ *
329
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
330
+ */
331
+ account_ref?: CurrencyRef;
332
+ /**
333
+ * A monetary amount.
334
+ *
335
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
336
+ */
337
+ amount?: number;
338
+ /**
339
+ * The check number of a check that a QuickBooks user writes or receives from someone else.
340
+ *
341
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
342
+ */
343
+ check_number?: string;
344
+ /**
345
+ * Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
346
+ *
347
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
348
+ */
349
+ class_ref?: CurrencyRef;
350
+ /**
351
+ * A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a BillToPayQuery message, `entity_ref` refers to the vendor name. In JournalCreditLine and JournalDebitLine messages for A/R accounts, `entity_ref` must refer to a customer, or else the transaction won’t be recorded.
352
+ *
353
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
354
+ */
355
+ entity_ref?: CurrencyRef;
356
+ /**
357
+ * Additional information.
358
+ *
359
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
360
+ */
361
+ memo?: string;
362
+ /**
363
+ * Deposit line check number.
364
+ *
365
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
366
+ */
367
+ override_check_number?: string;
368
+ /**
369
+ * Deposit line class reference.
370
+ *
371
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
372
+ */
373
+ override_class_ref?: CurrencyRef;
374
+ /**
375
+ * Depost line memo additional information.
376
+ *
377
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
378
+ */
379
+ override_memo?: string;
380
+ /**
381
+ * `payment_method_ref` identifies how a payment is made (for example, cash, check, or card type). If both `full_name` and `list_id` are provided, `full_name` is ignored.
382
+ *
383
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
384
+ */
385
+ payment_method_ref?: CurrencyRef;
386
+ /**
387
+ * For the `payment_txn_id`, use either of these two values:A `txn_id` value exactly as it is returned by the ReceivePaymentToDepositQuery request, or A `txn_id` value exactly as it is returned in a ReceivePaymentAdd response.
388
+ *
389
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
390
+ */
391
+ payment_txn_id?: string;
392
+ /**
393
+ * For the `payment_txn_line_id`, use a `txn_line_id` value exactly as it has been returned by the ReceivePaymentToDepositQuery request. If you don’t include a `payment_txn_line_id` and include a `payment_txn_id` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited.
394
+ *
395
+ * Choose exactly one of: the set (`override_check_number`, `override_class_ref`, `override_memo`, `payment_txn_id`, `payment_txn_line_id`), or the set (`account_ref`, `amount`, `check_number`, `class_ref`, `entity_ref`, `memo`, `payment_method_ref`). Members of a set combine with each other, not with the other choices.
396
+ */
397
+ payment_txn_line_id?: string;
398
+ /**
399
+ * 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.
400
+ */
401
+ txn_line_id: string;
402
+ }
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks deposit operations. Types: deposit.d.ts. */
5
+ class Deposit {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create deposit.
15
+ * @param {string} connectionId
16
+ * @param {import("./deposit").DepositCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/deposits/create-deposit
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("deposit.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List deposits (answers in pages, one webhook each).
27
+ * @param {string} connectionId
28
+ * @param {import("./deposit").DepositQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/deposits/list-deposits
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("deposit.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update deposit.
39
+ * @param {string} connectionId
40
+ * @param {import("./deposit").DepositUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/deposits/update-deposit
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("deposit.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { Deposit };