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,368 @@
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, BarCodeItemDiscount, CurrencyRef, NameFilter, NameRangeFilter } from "./types";
5
+
6
+ /** QuickBooks item inventory assembly operations: `qube.itemInventoryAssembly.<action>(connectionId, params, { webhookUrl })`. */
7
+ export declare class ItemInventoryAssembly {
8
+ constructor(client: Client);
9
+ /**
10
+ * Create item inventory assembly: `POST /connections/{connection_id}/item-inventory-assemblies`, queued for QuickBooks.
11
+ *
12
+ * The answer comes to `webhookUrl` as one webhook.
13
+ * Params go in the JSON body.
14
+ *
15
+ * Fields: `asset_account_ref`, `bar_code`, `build_point`, `class_ref`, `cogs_account_ref`, `external_guid`, `include_ret_element`, `income_account_ref`, `inventory_date`, `is_active`, `is_tax_included`, `item_inventory_assembly_line`, `manufacturer_part_number`, `max`, `name` (required), `parent_ref`, `pref_vendor_ref`, `purchase_cost`, `purchase_desc`, `purchase_tax_code_ref`, `quantity_on_hand`, `request_id`, `sales_desc`, `sales_price`, `sales_tax_code_ref`, `total_value`, `unit_of_measure_set_ref`.
16
+ *
17
+ * Resolves to the queued request.
18
+ * @see https://docs.qubesync.com/api-reference/v2/item-inventory-assemblies/create-item-inventory-assembly
19
+ */
20
+ create(connectionId: string, params: ItemInventoryAssemblyCreateParams, options: OperationOptions): Promise<QueuedRequest>;
21
+ /**
22
+ * List item inventory assemblies: `GET /connections/{connection_id}/item-inventory-assemblies`, 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: `active_status`, `class_filter`, `from_modified_date`, `full_name`, `include_ret_element`, `iterator`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `owner_id`, `request_id`, `to_modified_date`.
28
+ *
29
+ * Resolves to the queued request.
30
+ * @see https://docs.qubesync.com/api-reference/v2/item-inventory-assemblies/list-item-inventory-assemblies
31
+ */
32
+ query(connectionId: string, params: ItemInventoryAssemblyQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
33
+ /**
34
+ * Update item inventory assembly: `PUT /connections/{connection_id}/item-inventory-assemblies`, queued for QuickBooks.
35
+ *
36
+ * The answer comes to `webhookUrl` as one webhook.
37
+ * Params go in the JSON body.
38
+ *
39
+ * Fields: `apply_income_account_ref_to_existing_txns`, `asset_account_ref`, `bar_code`, `build_point`, `class_ref`, `clear_items_in_group`, `cogs_account_ref`, `edit_sequence` (required), `force_uom_change`, `include_ret_element`, `income_account_ref`, `is_active`, `is_tax_included`, `item_inventory_assembly_line`, `list_id` (required), `manufacturer_part_number`, `max`, `name`, `parent_ref`, `pref_vendor_ref`, `purchase_cost`, `purchase_desc`, `purchase_tax_code_ref`, `request_id`, `sales_desc`, `sales_price`, `sales_tax_code_ref`, `unit_of_measure_set_ref`.
40
+ *
41
+ * Resolves to the queued request.
42
+ * @see https://docs.qubesync.com/api-reference/v2/item-inventory-assemblies/update-item-inventory-assembly
43
+ */
44
+ update(connectionId: string, params: ItemInventoryAssemblyUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
45
+ }
46
+
47
+ /**
48
+ * The params of `item_inventory_assembly.create`: Create item inventory assembly.
49
+ */
50
+ export interface ItemInventoryAssemblyCreateParams {
51
+ /**
52
+ * Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The AccountType of this account will be FixedAsset, OtherAsset, or OtherCurrentAsset.) In a request, if an `asset_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
53
+ */
54
+ asset_account_ref?: CurrencyRef;
55
+ /**
56
+ * Barcode reference information.
57
+ */
58
+ bar_code?: BarCodeItemDiscount;
59
+ /**
60
+ * The build notification point. The QuickBooks user will receive a notification when `quantity_on_hand` plus `quantity_on_order` falls below `build_point`.
61
+ */
62
+ build_point?: number;
63
+ /**
64
+ * 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.
65
+ */
66
+ class_ref?: CurrencyRef;
67
+ /**
68
+ * Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The AccountType of this account will be CostOfGoodsSold.) In a request, if a `cogs_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
69
+ */
70
+ cogs_account_ref?: CurrencyRef;
71
+ /**
72
+ * Allows for the attachment of a user defined GUID value.
73
+ */
74
+ external_guid?: string;
75
+ include_ret_element?: Array<"AssetAccountRef" | "AverageCost" | "BarCodeValue" | "BuildPoint" | "COGSAccountRef" | "ClassRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "FullName" | "IncomeAccountRef" | "IsActive" | "IsTaxIncluded" | "ItemInventoryAssemblyLine" | "ListID" | "ManufacturerPartNumber" | "Max" | "Name" | "OwnerID" | "ParentRef" | "PrefVendorRef" | "PurchaseCost" | "PurchaseDesc" | "PurchaseTaxCodeRef" | "QuantityOnHand" | "QuantityOnOrder" | "QuantityOnSalesOrder" | "SalesDesc" | "SalesPrice" | "SalesTaxCodeRef" | "Sublevel" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber" | "UnitOfMeasureSetRef">;
76
+ /**
77
+ * Refers to an income account. If an `income_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
78
+ */
79
+ income_account_ref?: CurrencyRef;
80
+ /**
81
+ * The date when an item was converted into an inventory item from some other type of item.
82
+ *
83
+ * Format: date.
84
+ */
85
+ inventory_date?: string;
86
+ /**
87
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
88
+ */
89
+ is_active?: boolean;
90
+ /**
91
+ * For future use with international versions of QuickBooks.
92
+ */
93
+ is_tax_included?: boolean;
94
+ item_inventory_assembly_line?: ItemInventoryAssemblyLine[];
95
+ /**
96
+ * The part number used by the manufacturer of the item.
97
+ */
98
+ manufacturer_part_number?: string;
99
+ /**
100
+ * Maximum number of items in inventory.
101
+ */
102
+ max?: number;
103
+ /**
104
+ * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct.
105
+ */
106
+ name: string;
107
+ /**
108
+ * A reference to the list object that is one level above this one. For example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request, if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
109
+ */
110
+ parent_ref?: CurrencyRef;
111
+ /**
112
+ * The preferred vendor for this item. If a `pref_vendor_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
113
+ */
114
+ pref_vendor_ref?: CurrencyRef;
115
+ /**
116
+ * Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item.
117
+ */
118
+ purchase_cost?: number;
119
+ /**
120
+ * Description that appears in the Description column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased.
121
+ */
122
+ purchase_desc?: string;
123
+ /**
124
+ * Account used for taxes on purchases in CA or UK.
125
+ */
126
+ purchase_tax_code_ref?: CurrencyRef;
127
+ /**
128
+ * The number of these items in inventory. `quantity_on_hand` times `average_cost` is `total_value` in an inventory item list. To change the `quantity_on_hand` for an item, you would have to use InventoryAdjustmentAdd not an ItemInventoryMod.
129
+ */
130
+ quantity_on_hand?: number;
131
+ /**
132
+ * 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`.
133
+ */
134
+ request_id?: string;
135
+ /**
136
+ * Appears in the Description column of a sales form when the QuickBooks user sells this item. For a fixed asset, describes the sale of the asset (for accounting purposes).
137
+ */
138
+ sales_desc?: string;
139
+ /**
140
+ * Price charged for this item.
141
+ */
142
+ sales_price?: number;
143
+ /**
144
+ * `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
145
+ */
146
+ sales_tax_code_ref?: CurrencyRef;
147
+ /**
148
+ * The total value of this inventory. If `total_value` is included, `quantity_on_hand` must also be included and must be greater than zero. If both `quantity_on_hand` and `purchase_cost` are included, then `total_value` will be set to `quantity_on_hand` times `purchase_cost`, regardless of what `total_value` is explicitly set to.
149
+ */
150
+ total_value?: number;
151
+ /**
152
+ * The unit of measure set consists of a base unit and 0-n related units.
153
+ */
154
+ unit_of_measure_set_ref?: CurrencyRef;
155
+ }
156
+
157
+ /**
158
+ * The params of `item_inventory_assembly.query`: List item inventory assemblies.
159
+ */
160
+ export interface ItemInventoryAssemblyQueryParams {
161
+ /**
162
+ * Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
163
+ *
164
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
165
+ */
166
+ active_status?: "ActiveOnly" | "All" | "InactiveOnly";
167
+ /**
168
+ * Filters according to the object’s class.
169
+ *
170
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
171
+ */
172
+ class_filter?: AccountFilter;
173
+ /**
174
+ * Filters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00.
175
+ *
176
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
177
+ *
178
+ * Format: date-time.
179
+ */
180
+ from_modified_date?: string;
181
+ /**
182
+ * `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
183
+ *
184
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
185
+ */
186
+ full_name?: string[];
187
+ include_ret_element?: Array<"AssetAccountRef" | "AverageCost" | "BarCodeValue" | "BuildPoint" | "COGSAccountRef" | "ClassRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "FullName" | "IncomeAccountRef" | "IsActive" | "IsTaxIncluded" | "ItemInventoryAssemblyLine" | "ListID" | "ManufacturerPartNumber" | "Max" | "Name" | "ParentRef" | "PrefVendorRef" | "PurchaseCost" | "PurchaseDesc" | "PurchaseTaxCodeRef" | "QuantityOnHand" | "QuantityOnOrder" | "QuantityOnSalesOrder" | "SalesDesc" | "SalesPrice" | "SalesTaxCodeRef" | "Sublevel" | "TimeCreated" | "TimeModified" | "UnitOfMeasureSetRef">;
188
+ /**
189
+ * 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; 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 `full_name` or `list_id` every match comes back in one answer, so leave `iterator` out.
190
+ */
191
+ iterator?: boolean;
192
+ /**
193
+ * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
194
+ *
195
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
196
+ */
197
+ list_id?: string[];
198
+ /**
199
+ * 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.
200
+ *
201
+ * 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.
202
+ *
203
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
204
+ *
205
+ * Minimum 1.
206
+ */
207
+ max_returned?: number;
208
+ /**
209
+ * 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.
210
+ */
211
+ meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
212
+ /**
213
+ * Filters according to the object’s Name.
214
+ *
215
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
216
+ */
217
+ name_filter?: NameFilter;
218
+ /**
219
+ * Filters according to the object’s Name.
220
+ *
221
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
222
+ */
223
+ name_range_filter?: NameRangeFilter;
224
+ /**
225
+ * `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.
226
+ */
227
+ owner_id?: string[];
228
+ /**
229
+ * 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`.
230
+ */
231
+ request_id?: string;
232
+ /**
233
+ * Filters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59).
234
+ *
235
+ * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `class_filter`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
236
+ *
237
+ * Format: date-time.
238
+ */
239
+ to_modified_date?: string;
240
+ }
241
+
242
+ /**
243
+ * The params of `item_inventory_assembly.update`: Update item inventory assembly.
244
+ */
245
+ export interface ItemInventoryAssemblyUpdateParams {
246
+ /**
247
+ * Used to support changing the AccountRef in the Mod request. When you do this, the QuickBooks UI normally displays a prompt asking whether the change should apply to existing transactions or not. Specifying False basically dismisses this with a “No” answer; specifying True dismisses it with a “Yes” answer and then changes the existing transactions that use the item with that AccountRef.
248
+ */
249
+ apply_income_account_ref_to_existing_txns?: boolean;
250
+ /**
251
+ * Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The AccountType of this account will be FixedAsset, OtherAsset, or OtherCurrentAsset.) In a request, if an `asset_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
252
+ */
253
+ asset_account_ref?: CurrencyRef;
254
+ /**
255
+ * Barcode reference information.
256
+ */
257
+ bar_code?: BarCodeItemDiscount;
258
+ /**
259
+ * The build notification point. The QuickBooks user will receive a notification when `quantity_on_hand` plus `quantity_on_order` falls below `build_point`.
260
+ */
261
+ build_point?: number;
262
+ /**
263
+ * 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.
264
+ */
265
+ class_ref?: CurrencyRef;
266
+ /**
267
+ * Set to true to clear all the items in this group.
268
+ *
269
+ * Choose at most one of: `clear_items_in_group`, or `item_inventory_assembly_line`.
270
+ */
271
+ clear_items_in_group?: boolean;
272
+ /**
273
+ * Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The AccountType of this account will be CostOfGoodsSold.) In a request, if a `cogs_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
274
+ */
275
+ cogs_account_ref?: CurrencyRef;
276
+ /**
277
+ * `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.
278
+ */
279
+ edit_sequence: string;
280
+ /**
281
+ * By Default `force_uom_change` is false. However, in item Mod requests, you need to set the `force_uom_change` field to True if you are changing the UOM set and the base unit of the new set doesn’t match the base unit of the UOM set currently assigned to the item. This does the same thing as the user accepting the warning prompt in the UI.
282
+ */
283
+ force_uom_change?: boolean;
284
+ include_ret_element?: Array<"AssetAccountRef" | "AverageCost" | "BarCodeValue" | "BuildPoint" | "COGSAccountRef" | "ClassRef" | "DataExtRet" | "EditSequence" | "ExternalGUID" | "FullName" | "IncomeAccountRef" | "IsActive" | "IsTaxIncluded" | "ItemInventoryAssemblyLine" | "ListID" | "ManufacturerPartNumber" | "Max" | "Name" | "OwnerID" | "ParentRef" | "PrefVendorRef" | "PurchaseCost" | "PurchaseDesc" | "PurchaseTaxCodeRef" | "QuantityOnHand" | "QuantityOnOrder" | "QuantityOnSalesOrder" | "SalesDesc" | "SalesPrice" | "SalesTaxCodeRef" | "Sublevel" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber" | "UnitOfMeasureSetRef">;
285
+ /**
286
+ * Refers to an income account. If an `income_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
287
+ */
288
+ income_account_ref?: CurrencyRef;
289
+ /**
290
+ * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
291
+ */
292
+ is_active?: boolean;
293
+ /**
294
+ * For future use with international versions of QuickBooks.
295
+ */
296
+ is_tax_included?: boolean;
297
+ /**
298
+ * Choose at most one of: `clear_items_in_group`, or `item_inventory_assembly_line`.
299
+ */
300
+ item_inventory_assembly_line?: ItemInventoryAssemblyLine[];
301
+ /**
302
+ * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
303
+ */
304
+ list_id: string;
305
+ /**
306
+ * The part number used by the manufacturer of the item.
307
+ */
308
+ manufacturer_part_number?: string;
309
+ /**
310
+ * Maximum number of items in inventory.
311
+ */
312
+ max?: number;
313
+ /**
314
+ * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because `full_name` remains distinct.
315
+ */
316
+ name?: string;
317
+ /**
318
+ * A reference to the list object that is one level above this one. For example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request, if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
319
+ */
320
+ parent_ref?: CurrencyRef;
321
+ /**
322
+ * The preferred vendor for this item. If a `pref_vendor_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
323
+ */
324
+ pref_vendor_ref?: CurrencyRef;
325
+ /**
326
+ * Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item.
327
+ */
328
+ purchase_cost?: number;
329
+ /**
330
+ * Description that appears in the Description column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased.
331
+ */
332
+ purchase_desc?: string;
333
+ /**
334
+ * Account used for taxes on purchases in CA or UK.
335
+ */
336
+ purchase_tax_code_ref?: CurrencyRef;
337
+ /**
338
+ * 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`.
339
+ */
340
+ request_id?: string;
341
+ /**
342
+ * Appears in the Description column of a sales form when the QuickBooks user sells this item. For a fixed asset, describes the sale of the asset (for accounting purposes).
343
+ */
344
+ sales_desc?: string;
345
+ /**
346
+ * Price charged for this item.
347
+ */
348
+ sales_price?: number;
349
+ /**
350
+ * `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
351
+ */
352
+ sales_tax_code_ref?: CurrencyRef;
353
+ /**
354
+ * The unit of measure set consists of a base unit and 0-n related units.
355
+ */
356
+ unit_of_measure_set_ref?: CurrencyRef;
357
+ }
358
+
359
+ export interface ItemInventoryAssemblyLine {
360
+ /**
361
+ * An inventory item is any merchandise or part that a business purchases, tracks as inventory, and then resells. In QuickBooks, information about an inventory item is grouped into three categories:Puchase Information includes `purchase_desc`, `purchase_cost`, `cogs_account_ref`, and `pref_vendor_ref`. Sales Information includes `sales_desc`, `sales_price`, and `sales_tax_code_ref`.
362
+ */
363
+ item_inventory_ref: CurrencyRef;
364
+ /**
365
+ * On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
366
+ */
367
+ quantity?: number;
368
+ }
@@ -0,0 +1,50 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+ "use strict";
3
+
4
+ /** QuickBooks item inventory assembly operations. Types: item_inventory_assembly.d.ts. */
5
+ class ItemInventoryAssembly {
6
+ #client;
7
+
8
+ /** @param {import("../index").Client} client */
9
+ constructor(client) {
10
+ this.#client = client;
11
+ }
12
+
13
+ /**
14
+ * Create item inventory assembly.
15
+ * @param {string} connectionId
16
+ * @param {import("./item_inventory_assembly").ItemInventoryAssemblyCreateParams} params
17
+ * @param {import("./types").OperationOptions} options
18
+ * @returns {Promise<import("./types").QueuedRequest>}
19
+ * @see https://docs.qubesync.com/api-reference/v2/item-inventory-assemblies/create-item-inventory-assembly
20
+ */
21
+ create(connectionId, params, options) {
22
+ return this.#client.queue("item_inventory_assembly.create", connectionId, params, options);
23
+ }
24
+
25
+ /**
26
+ * List item inventory assemblies (answers in pages, one webhook each).
27
+ * @param {string} connectionId
28
+ * @param {import("./item_inventory_assembly").ItemInventoryAssemblyQueryParams} params
29
+ * @param {import("./types").OperationOptions} options
30
+ * @returns {Promise<import("./types").QueuedRequest>}
31
+ * @see https://docs.qubesync.com/api-reference/v2/item-inventory-assemblies/list-item-inventory-assemblies
32
+ */
33
+ query(connectionId, params, options) {
34
+ return this.#client.queue("item_inventory_assembly.query", connectionId, params, options);
35
+ }
36
+
37
+ /**
38
+ * Update item inventory assembly.
39
+ * @param {string} connectionId
40
+ * @param {import("./item_inventory_assembly").ItemInventoryAssemblyUpdateParams} params
41
+ * @param {import("./types").OperationOptions} options
42
+ * @returns {Promise<import("./types").QueuedRequest>}
43
+ * @see https://docs.qubesync.com/api-reference/v2/item-inventory-assemblies/update-item-inventory-assembly
44
+ */
45
+ update(connectionId, params, options) {
46
+ return this.#client.queue("item_inventory_assembly.update", connectionId, params, options);
47
+ }
48
+ }
49
+
50
+ module.exports = { ItemInventoryAssembly };