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,290 @@
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, RefNumberFilter, RefNumberRangeFilter, TxnDateRangeFilter } from "./types";
5
+
6
+ /** QuickBooks transfer inventory operations: `qube.transferInventory.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class TransferInventory {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create transfer inventory: `POST /connections/{connection_id}/transfer-inventories`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `def_macro`, `external_guid`, `from_inventory_site_ref` (required), `include_ret_element`, `memo`, `ref_number`, `request_id`, `to_inventory_site_ref` (required), `transfer_inventory_line_add`, `txn_date`.
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/transfer-inventories/create-transfer-inventory
19
+ */
20
+ create(connectionId: string, params: TransferInventoryCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * List transfer inventories: `GET /connections/{connection_id}/transfer-inventories`, 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`, `entity_filter`, `include_line_items`, `include_ret_element`, `iterator`, `max_returned`, `meta_data`, `modified_date_range_filter`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `site_filter`, `txn_date_range_filter`, `txn_id`.
28
+ *
29
+ * Resolves to the queued request.
30
+ * @see https://docs.qubesync.com/api-reference/v2/transfer-inventories/list-transfer-inventories
31
+ */
32
+ query(connectionId: string, params: TransferInventoryQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
33
+ /**
34
+ * Update transfer inventory: `PUT /connections/{connection_id}/transfer-inventories`, queued for QuickBooks.
35
+ *
36
+ * The answer comes to `webhookUrl` as one webhook.
37
+ * Params go in the JSON body.
38
+ *
39
+ * Fields: `edit_sequence` (required), `from_inventory_site_ref`, `include_ret_element`, `memo`, `ref_number`, `request_id`, `to_inventory_site_ref`, `transfer_inventory_line_mod`, `txn_date`, `txn_id` (required).
40
+ *
41
+ * Resolves to the queued request.
42
+ * @see https://docs.qubesync.com/api-reference/v2/transfer-inventories/update-transfer-inventory
43
+ */
44
+ update(connectionId: string, params: TransferInventoryUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
45
+ }
46
+
47
+ /**
48
+ * The params of `transfer_inventory.create`: Create transfer inventory.
49
+ */
50
+ export interface TransferInventoryCreateParams {
51
+ /**
52
+ * `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+.
53
+ */
54
+ def_macro?: string;
55
+ /**
56
+ * Allows for the attachment of a user defined GUID value.
57
+ */
58
+ external_guid?: string;
59
+ /**
60
+ * Inventory site that transfer will be taken from.
61
+ */
62
+ from_inventory_site_ref: CurrencyRef;
63
+ include_ret_element?: Array<"EditSequence" | "ExternalGUID" | "FromInventorySiteRef" | "ListID" | "Memo" | "OwnerID" | "RefNumber" | "TimeCreated" | "TimeModified" | "ToInventorySiteRef" | "TransferInventoryLineRet" | "TxnDate" | "TxnID" | "TxnNumber">;
64
+ /**
65
+ * Additional information.
66
+ */
67
+ memo?: string;
68
+ /**
69
+ * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
70
+ */
71
+ ref_number?: string;
72
+ /**
73
+ * 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`.
74
+ */
75
+ request_id?: string;
76
+ /**
77
+ * Inventory site that transfer will be sent to.
78
+ */
79
+ to_inventory_site_ref: CurrencyRef;
80
+ transfer_inventory_line_add?: TransferInventoryLineAdd[];
81
+ /**
82
+ * 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.
83
+ *
84
+ * Format: date.
85
+ */
86
+ txn_date?: string;
87
+ }
88
+
89
+ /**
90
+ * The params of `transfer_inventory.query`: List transfer inventories.
91
+ */
92
+ export interface TransferInventoryQueryParams {
93
+ /**
94
+ * 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.
95
+ *
96
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
97
+ */
98
+ account_filter?: AccountFilter;
99
+ /**
100
+ * 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.
101
+ *
102
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
103
+ */
104
+ entity_filter?: AccountFilter;
105
+ /**
106
+ * 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.
107
+ */
108
+ include_line_items?: boolean;
109
+ include_ret_element?: Array<"EditSequence" | "ExternalGUID" | "FromInventorySiteRef" | "Memo" | "RefNumber" | "TimeCreated" | "TimeModified" | "ToInventorySiteRef" | "TransferInventoryLineRet" | "TxnDate" | "TxnID" | "TxnNumber">;
110
+ /**
111
+ * 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 `ref_number`, `ref_number_case_sensitive`, `site_filter` or `txn_id` every match comes back in one answer, so leave `iterator` out.
112
+ */
113
+ iterator?: boolean;
114
+ /**
115
+ * 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.
116
+ *
117
+ * 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.
118
+ *
119
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
120
+ *
121
+ * Minimum 1.
122
+ */
123
+ max_returned?: number;
124
+ /**
125
+ * 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.
126
+ */
127
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
128
+ /**
129
+ * 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.
130
+ *
131
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
132
+ */
133
+ modified_date_range_filter?: ModifiedDateRangeFilter;
134
+ /**
135
+ * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
136
+ *
137
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
138
+ */
139
+ ref_number?: string[];
140
+ /**
141
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
142
+ */
143
+ ref_number_case_sensitive?: string[];
144
+ /**
145
+ * Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
146
+ *
147
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
148
+ */
149
+ ref_number_filter?: RefNumberFilter;
150
+ /**
151
+ * Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
152
+ *
153
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
154
+ */
155
+ ref_number_range_filter?: RefNumberRangeFilter;
156
+ /**
157
+ * 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`.
158
+ */
159
+ request_id?: string;
160
+ /**
161
+ * Allows you to report on Sites.
162
+ *
163
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
164
+ */
165
+ site_filter?: CurrencyFilter;
166
+ /**
167
+ * Filters according to the original transaction dates.
168
+ *
169
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
170
+ */
171
+ txn_date_range_filter?: TxnDateRangeFilter;
172
+ /**
173
+ * `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.
174
+ *
175
+ * Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`), or `site_filter`. Members of a set combine with each other, not with the other choices.
176
+ */
177
+ txn_id?: string[];
178
+ }
179
+
180
+ /**
181
+ * The params of `transfer_inventory.update`: Update transfer inventory.
182
+ */
183
+ export interface TransferInventoryUpdateParams {
184
+ /**
185
+ * `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.
186
+ */
187
+ edit_sequence: string;
188
+ /**
189
+ * Inventory site that transfer will be taken from.
190
+ */
191
+ from_inventory_site_ref?: CurrencyRef;
192
+ include_ret_element?: Array<"EditSequence" | "ExternalGUID" | "FromInventorySiteRef" | "ListID" | "Memo" | "OwnerID" | "RefNumber" | "TimeCreated" | "TimeModified" | "ToInventorySiteRef" | "TransferInventoryLineRet" | "TxnDate" | "TxnID" | "TxnNumber">;
193
+ /**
194
+ * Additional information.
195
+ */
196
+ memo?: string;
197
+ /**
198
+ * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
199
+ */
200
+ ref_number?: string;
201
+ /**
202
+ * 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`.
203
+ */
204
+ request_id?: string;
205
+ /**
206
+ * Inventory site that transfer will be sent to.
207
+ */
208
+ to_inventory_site_ref?: CurrencyRef;
209
+ transfer_inventory_line_mod?: TransferInventoryLineMod[];
210
+ /**
211
+ * 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.
212
+ *
213
+ * Format: date.
214
+ */
215
+ txn_date?: string;
216
+ /**
217
+ * `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.
218
+ */
219
+ txn_id: string;
220
+ }
221
+
222
+ export interface TransferInventoryLineAdd {
223
+ /**
224
+ * `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+.
225
+ */
226
+ def_macro?: string;
227
+ /**
228
+ * Location within the inventory site that transfer will be taken from.
229
+ */
230
+ from_inventory_site_location_ref?: CurrencyRef;
231
+ /**
232
+ * `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
233
+ */
234
+ item_ref?: CurrencyRef;
235
+ /**
236
+ * The lot number of the asset.
237
+ *
238
+ * Choose at most one of: `serial_number`, or `lot_number`.
239
+ */
240
+ lot_number?: string;
241
+ /**
242
+ * Quantity of items transferred.
243
+ */
244
+ quantity_to_transfer?: number;
245
+ /**
246
+ * The serial number of the asset.
247
+ *
248
+ * Choose at most one of: `serial_number`, or `lot_number`.
249
+ */
250
+ serial_number?: string;
251
+ /**
252
+ * Location within the inventory site that transfer will be sent to.
253
+ */
254
+ to_inventory_site_location_ref?: CurrencyRef;
255
+ }
256
+
257
+ export interface TransferInventoryLineMod {
258
+ /**
259
+ * Location within the inventory site that transfer will be taken from.
260
+ */
261
+ from_inventory_site_location_ref?: CurrencyRef;
262
+ /**
263
+ * `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
264
+ */
265
+ item_ref?: CurrencyRef;
266
+ /**
267
+ * The lot number of the asset.
268
+ *
269
+ * Choose at most one of: `serial_number`, or `lot_number`.
270
+ */
271
+ lot_number?: string;
272
+ /**
273
+ * Quantity of items transferred.
274
+ */
275
+ quantity_to_transfer?: number;
276
+ /**
277
+ * The serial number of the asset.
278
+ *
279
+ * Choose at most one of: `serial_number`, or `lot_number`.
280
+ */
281
+ serial_number?: string;
282
+ /**
283
+ * Location within the inventory site that transfer will be sent to.
284
+ */
285
+ to_inventory_site_location_ref?: CurrencyRef;
286
+ /**
287
+ * 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.
288
+ */
289
+ txn_line_id: string;
290
+ }
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks transfer inventory operations. Types: transfer_inventory.d.ts. */
5
+ class TransferInventory {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create transfer inventory.
15
+ * @param {string} connectionId
16
+ * @param {import("./transfer_inventory").TransferInventoryCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/transfer-inventories/create-transfer-inventory
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("transfer_inventory.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List transfer inventories (answers in pages, one webhook each).
27
+ * @param {string} connectionId
28
+ * @param {import("./transfer_inventory").TransferInventoryQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/transfer-inventories/list-transfer-inventories
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("transfer_inventory.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update transfer inventory.
39
+ * @param {string} connectionId
40
+ * @param {import("./transfer_inventory").TransferInventoryUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/transfer-inventories/update-transfer-inventory
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("transfer_inventory.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { TransferInventory };
@@ -0,0 +1,39 @@
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 txn operations: `qube.txn.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class Txn {
8
+ constructor(client: Client);
9
+ /**
10
+ * Delete txn: `DELETE /connections/{connection_id}/txns`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `request_id`, `txn_del_type` (required), `txn_id` (required).
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/txns/delete-txn
19
+ */
20
+ delete(connectionId: string, params: TxnDeleteParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ }
22
+
23
+ /**
24
+ * The params of `txn.delete`: Delete txn.
25
+ */
26
+ export interface TxnDeleteParams {
27
+ /**
28
+ * 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`.
29
+ */
30
+ request_id?: string;
31
+ /**
32
+ * The type of transaction to be deleted.
33
+ */
34
+ txn_del_type: "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "TimeTracking" | "TransferInventory" | "VehicleMileage" | "VendorCredit";
35
+ /**
36
+ * `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.
37
+ */
38
+ txn_id: string;
39
+ }
@@ -0,0 +1,26 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks txn operations. Types: txn.d.ts. */
5
+ class Txn {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Delete txn.
15
+ * @param {string} connectionId
16
+ * @param {import("./txn").TxnDeleteParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/txns/delete-txn
20
+ */
21
+ delete(connectionId, params, options) {
22
+ return this.#client.queue("txn.delete", connectionId, params, options);
23
+ }
24
+ }
25
+
26
+ module.exports = { Txn };
@@ -0,0 +1,44 @@
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, DeletedDateRangeFilter } from "./types";
5
+
6
+ /** QuickBooks txn deleted operations: `qube.txnDeleted.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class TxnDeleted {
8
+ constructor(client: Client);
9
+ /**
10
+ * List txn deleteds: `GET /connections/{connection_id}/txn-deleteds`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the query string.
14
+ *
15
+ * Fields: `deleted_date_range_filter`, `include_ret_element`, `meta_data`, `request_id`, `txn_del_type` (required).
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/txn-deleteds/list-txn-deleteds
19
+ */
20
+ query(connectionId: string, params: TxnDeletedQueryParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ }
22
+
23
+ /**
24
+ * The params of `txn_deleted.query`: List txn deleteds.
25
+ */
26
+ export interface TxnDeletedQueryParams {
27
+ /**
28
+ * Filters according to delete dates (within the last 90 days).
29
+ */
30
+ deleted_date_range_filter?: DeletedDateRangeFilter;
31
+ include_ret_element?: Array<"RefNumber" | "TimeCreated" | "TimeDeleted" | "TxnDelType" | "TxnID">;
32
+ /**
33
+ * 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.
34
+ */
35
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
36
+ /**
37
+ * 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`.
38
+ */
39
+ request_id?: string;
40
+ /**
41
+ * The type of transaction to be deleted.
42
+ */
43
+ txn_del_type: Array<"ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "TimeTracking" | "TransferInventory" | "VehicleMileage" | "VendorCredit">;
44
+ }
@@ -0,0 +1,26 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks txn deleted operations. Types: txn_deleted.d.ts. */
5
+ class TxnDeleted {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * List txn deleteds.
15
+ * @param {string} connectionId
16
+ * @param {import("./txn_deleted").TxnDeletedQueryParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/txn-deleteds/list-txn-deleteds
20
+ */
21
+ query(connectionId, params, options) {
22
+ return this.#client.queue("txn_deleted.query", connectionId, params, options);
23
+ }
24
+ }
25
+
26
+ module.exports = { TxnDeleted };
@@ -0,0 +1,69 @@
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 txn display operations: `qube.txnDisplay.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class TxnDisplay {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create txn display: `POST /connections/{connection_id}/txn-displays`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `entity_ref`, `request_id`, `txn_display_add_type` (required).
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/txn-displays/create-txn-display
19
+ */
20
+ create(connectionId: string, params: TxnDisplayCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * Update txn display: `PUT /connections/{connection_id}/txn-displays`, queued for QuickBooks.
23
+ *
24
+ * The answer comes to `webhookUrl` as one webhook.
25
+ * Params go in the JSON body.
26
+ *
27
+ * Fields: `request_id`, `txn_display_mod_type` (required), `txn_id` (required).
28
+ *
29
+ * Resolves to the queued request.
30
+ * @see https://docs.qubesync.com/api-reference/v2/txn-displays/update-txn-display
31
+ */
32
+ update(connectionId: string, params: TxnDisplayUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
33
+ }
34
+
35
+ /**
36
+ * The params of `txn_display.create`: Create txn display.
37
+ */
38
+ export interface TxnDisplayCreateParams {
39
+ /**
40
+ * 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.
41
+ */
42
+ entity_ref?: CurrencyRef;
43
+ /**
44
+ * 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`.
45
+ */
46
+ request_id?: string;
47
+ /**
48
+ * Specifies the type of QuickBooks transaction for which to open an edit form in the QuickBooks UI. Notice that some transaction types don’t support the entity reference that “prefills” the form because it would make no sense to do this for certain forms.
49
+ */
50
+ txn_display_add_type: "Bill" | "BillPayment" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "VendorCredit";
51
+ }
52
+
53
+ /**
54
+ * The params of `txn_display.update`: Update txn display.
55
+ */
56
+ export interface TxnDisplayUpdateParams {
57
+ /**
58
+ * 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`.
59
+ */
60
+ request_id?: string;
61
+ /**
62
+ * The type of QuickBooks transaction to open for modification in the QuickBooks UI. (`txn_id` specifies the particular transaction.)
63
+ */
64
+ txn_display_mod_type: "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "VendorCredit";
65
+ /**
66
+ * `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.
67
+ */
68
+ txn_id: string;
69
+ }
@@ -0,0 +1,38 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks txn display operations. Types: txn_display.d.ts. */
5
+ class TxnDisplay {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create txn display.
15
+ * @param {string} connectionId
16
+ * @param {import("./txn_display").TxnDisplayCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/txn-displays/create-txn-display
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("txn_display.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * Update txn display.
27
+ * @param {string} connectionId
28
+ * @param {import("./txn_display").TxnDisplayUpdateParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/txn-displays/update-txn-display
32
+ */
33
+ update(connectionId, params, options) {
34
+ return this.#client.queue("txn_display.update", connectionId, params, options);
35
+ }
36
+ }
37
+
38
+ module.exports = { TxnDisplay };
@@ -0,0 +1,39 @@
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 txn void operations: `qube.txnVoid.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class TxnVoid {
8
+ constructor(client: Client);
9
+ /**
10
+ * Execute txn void: `POST /connections/{connection_id}/txn-void`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `request_id`, `txn_id` (required), `txn_void_type` (required).
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/txn-void/execute-txn-void
19
+ */
20
+ execute(connectionId: string, params: TxnVoidExecuteParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ }
22
+
23
+ /**
24
+ * The params of `txn_void.execute`: Execute txn void.
25
+ */
26
+ export interface TxnVoidExecuteParams {
27
+ /**
28
+ * 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`.
29
+ */
30
+ request_id?: string;
31
+ /**
32
+ * `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.
33
+ */
34
+ txn_id: string;
35
+ /**
36
+ * The type of transaction being voided.
37
+ */
38
+ txn_void_type: "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "SalesReceipt" | "VendorCredit";
39
+ }
@@ -0,0 +1,26 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks txn void operations. Types: txn_void.d.ts. */
5
+ class TxnVoid {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Execute txn void.
15
+ * @param {string} connectionId
16
+ * @param {import("./txn_void").TxnVoidExecuteParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/txn-void/execute-txn-void
20
+ */
21
+ execute(connectionId, params, options) {
22
+ return this.#client.queue("txn_void.execute", connectionId, params, options);
23
+ }
24
+ }
25
+
26
+ module.exports = { TxnVoid };