qube_sync 0.3.0 → 0.4.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 (260) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +48 -0
  3. data/README.md +235 -75
  4. data/Rakefile +12 -0
  5. data/lib/qube_sync/client.rb +579 -0
  6. data/lib/qube_sync/operations/account.rb +337 -0
  7. data/lib/qube_sync/operations/account_tax_line_info.rb +30 -0
  8. data/lib/qube_sync/operations/aging_report.rb +160 -0
  9. data/lib/qube_sync/operations/alert.rb +91 -0
  10. data/lib/qube_sync/operations/ar_refund_credit_card.rb +399 -0
  11. data/lib/qube_sync/operations/bar_code.rb +37 -0
  12. data/lib/qube_sync/operations/bill.rb +1073 -0
  13. data/lib/qube_sync/operations/bill_payment_check.rb +413 -0
  14. data/lib/qube_sync/operations/bill_payment_credit_card.rb +315 -0
  15. data/lib/qube_sync/operations/bill_to_pay.rb +66 -0
  16. data/lib/qube_sync/operations/billing_rate.rb +172 -0
  17. data/lib/qube_sync/operations/budget_summary_report.rb +80 -0
  18. data/lib/qube_sync/operations/build_assembly.rb +318 -0
  19. data/lib/qube_sync/operations/charge.rb +452 -0
  20. data/lib/qube_sync/operations/check.rb +1055 -0
  21. data/lib/qube_sync/operations/class.rb +176 -0
  22. data/lib/qube_sync/operations/cleared_status.rb +39 -0
  23. data/lib/qube_sync/operations/company.rb +39 -0
  24. data/lib/qube_sync/operations/company_activity.rb +31 -0
  25. data/lib/qube_sync/operations/credit_card_charge.rb +1000 -0
  26. data/lib/qube_sync/operations/credit_card_credit.rb +1000 -0
  27. data/lib/qube_sync/operations/credit_memo.rb +1243 -0
  28. data/lib/qube_sync/operations/currency.rb +195 -0
  29. data/lib/qube_sync/operations/custom_detail_report.rb +176 -0
  30. data/lib/qube_sync/operations/custom_summary_report.rb +180 -0
  31. data/lib/qube_sync/operations/customer.rb +744 -0
  32. data/lib/qube_sync/operations/customer_msg.rb +117 -0
  33. data/lib/qube_sync/operations/customer_type.rb +133 -0
  34. data/lib/qube_sync/operations/data_event_recovery_info.rb +54 -0
  35. data/lib/qube_sync/operations/data_ext.rb +201 -0
  36. data/lib/qube_sync/operations/data_ext_def.rb +179 -0
  37. data/lib/qube_sync/operations/date_driven_terms.rb +131 -0
  38. data/lib/qube_sync/operations/deposit.rb +555 -0
  39. data/lib/qube_sync/operations/employee.rb +577 -0
  40. data/lib/qube_sync/operations/employee_default.rb +100 -0
  41. data/lib/qube_sync/operations/entity.rb +118 -0
  42. data/lib/qube_sync/operations/estimate.rb +1055 -0
  43. data/lib/qube_sync/operations/form1099_category_account_mapping.rb +90 -0
  44. data/lib/qube_sync/operations/general_detail_report.rb +185 -0
  45. data/lib/qube_sync/operations/general_summary_report.rb +180 -0
  46. data/lib/qube_sync/operations/host.rb +36 -0
  47. data/lib/qube_sync/operations/inventory_adjustment.rb +482 -0
  48. data/lib/qube_sync/operations/inventory_site.rb +214 -0
  49. data/lib/qube_sync/operations/invoice.rb +1208 -0
  50. data/lib/qube_sync/operations/item.rb +115 -0
  51. data/lib/qube_sync/operations/item_assemblies_can_build.rb +44 -0
  52. data/lib/qube_sync/operations/item_discount.rb +319 -0
  53. data/lib/qube_sync/operations/item_fixed_asset.rb +317 -0
  54. data/lib/qube_sync/operations/item_group.rb +253 -0
  55. data/lib/qube_sync/operations/item_inventory.rb +446 -0
  56. data/lib/qube_sync/operations/item_inventory_assembly.rb +483 -0
  57. data/lib/qube_sync/operations/item_non_inventory.rb +461 -0
  58. data/lib/qube_sync/operations/item_other_charge.rb +434 -0
  59. data/lib/qube_sync/operations/item_payment.rb +268 -0
  60. data/lib/qube_sync/operations/item_receipt.rb +1011 -0
  61. data/lib/qube_sync/operations/item_sales_tax.rb +270 -0
  62. data/lib/qube_sync/operations/item_sales_tax_group.rb +200 -0
  63. data/lib/qube_sync/operations/item_service.rb +455 -0
  64. data/lib/qube_sync/operations/item_sites.rb +96 -0
  65. data/lib/qube_sync/operations/item_subtotal.rb +182 -0
  66. data/lib/qube_sync/operations/job_report.rb +156 -0
  67. data/lib/qube_sync/operations/job_type.rb +131 -0
  68. data/lib/qube_sync/operations/journal_entry.rb +518 -0
  69. data/lib/qube_sync/operations/lead.rb +216 -0
  70. data/lib/qube_sync/operations/list.rb +42 -0
  71. data/lib/qube_sync/operations/list_deleted.rb +57 -0
  72. data/lib/qube_sync/operations/list_display.rb +59 -0
  73. data/lib/qube_sync/operations/list_merge.rb +55 -0
  74. data/lib/qube_sync/operations/other_name.rb +245 -0
  75. data/lib/qube_sync/operations/paycheck.rb +139 -0
  76. data/lib/qube_sync/operations/payment_method.rb +128 -0
  77. data/lib/qube_sync/operations/payroll_detail_report.rb +161 -0
  78. data/lib/qube_sync/operations/payroll_item.rb +75 -0
  79. data/lib/qube_sync/operations/payroll_item_addition.rb +98 -0
  80. data/lib/qube_sync/operations/payroll_item_company_contribution.rb +134 -0
  81. data/lib/qube_sync/operations/payroll_item_deduction.rb +124 -0
  82. data/lib/qube_sync/operations/payroll_item_direct_deposit.rb +70 -0
  83. data/lib/qube_sync/operations/payroll_item_non_wage.rb +93 -0
  84. data/lib/qube_sync/operations/payroll_item_tax.rb +123 -0
  85. data/lib/qube_sync/operations/payroll_item_wage.rb +168 -0
  86. data/lib/qube_sync/operations/payroll_item_workers_compensation.rb +108 -0
  87. data/lib/qube_sync/operations/payroll_last_period.rb +30 -0
  88. data/lib/qube_sync/operations/payroll_liability_adjustment.rb +204 -0
  89. data/lib/qube_sync/operations/payroll_liability_check.rb +137 -0
  90. data/lib/qube_sync/operations/payroll_prior_payment.rb +178 -0
  91. data/lib/qube_sync/operations/payroll_summary_report.rb +157 -0
  92. data/lib/qube_sync/operations/payroll_year_to_date_adjustment.rb +211 -0
  93. data/lib/qube_sync/operations/preferences.rb +61 -0
  94. data/lib/qube_sync/operations/price_level.rb +305 -0
  95. data/lib/qube_sync/operations/purchase_order.rb +1038 -0
  96. data/lib/qube_sync/operations/qb_command_exec.rb +37 -0
  97. data/lib/qube_sync/operations/receive_payment.rb +627 -0
  98. data/lib/qube_sync/operations/receive_payment_to_deposit.rb +38 -0
  99. data/lib/qube_sync/operations/sales_order.rb +1045 -0
  100. data/lib/qube_sync/operations/sales_receipt.rb +1337 -0
  101. data/lib/qube_sync/operations/sales_rep.rb +172 -0
  102. data/lib/qube_sync/operations/sales_tax_code.rb +205 -0
  103. data/lib/qube_sync/operations/sales_tax_payable.rb +37 -0
  104. data/lib/qube_sync/operations/sales_tax_payment_check.rb +375 -0
  105. data/lib/qube_sync/operations/sales_tax_return.rb +35 -0
  106. data/lib/qube_sync/operations/sales_tax_return_line.rb +43 -0
  107. data/lib/qube_sync/operations/ship_method.rb +116 -0
  108. data/lib/qube_sync/operations/special_account.rb +55 -0
  109. data/lib/qube_sync/operations/special_item.rb +44 -0
  110. data/lib/qube_sync/operations/standard_terms.rb +125 -0
  111. data/lib/qube_sync/operations/template.rb +36 -0
  112. data/lib/qube_sync/operations/terms.rb +91 -0
  113. data/lib/qube_sync/operations/time_report.rb +127 -0
  114. data/lib/qube_sync/operations/time_tracking.rb +303 -0
  115. data/lib/qube_sync/operations/to_do.rb +260 -0
  116. data/lib/qube_sync/operations/transaction.rb +356 -0
  117. data/lib/qube_sync/operations/transfer.rb +213 -0
  118. data/lib/qube_sync/operations/transfer_inventory.rb +384 -0
  119. data/lib/qube_sync/operations/txn.rb +38 -0
  120. data/lib/qube_sync/operations/txn_deleted.rb +54 -0
  121. data/lib/qube_sync/operations/txn_display.rb +76 -0
  122. data/lib/qube_sync/operations/txn_void.rb +36 -0
  123. data/lib/qube_sync/operations/unit_of_measure_set.rb +149 -0
  124. data/lib/qube_sync/operations/vehicle.rb +152 -0
  125. data/lib/qube_sync/operations/vehicle_mileage.rb +191 -0
  126. data/lib/qube_sync/operations/vendor.rb +661 -0
  127. data/lib/qube_sync/operations/vendor_credit.rb +1008 -0
  128. data/lib/qube_sync/operations/vendor_type.rb +131 -0
  129. data/lib/qube_sync/operations/workers_comp_code.rb +184 -0
  130. data/lib/qube_sync/operations.rb +1165 -0
  131. data/lib/qube_sync/version.rb +1 -1
  132. data/lib/qube_sync.rb +1 -0
  133. data/sig/qube_sync/client.rbs +82 -0
  134. data/sig/qube_sync/operations/account.rbs +65 -0
  135. data/sig/qube_sync/operations/account_tax_line_info.rbs +13 -0
  136. data/sig/qube_sync/operations/aging_report.rbs +29 -0
  137. data/sig/qube_sync/operations/alert.rbs +53 -0
  138. data/sig/qube_sync/operations/ar_refund_credit_card.rbs +53 -0
  139. data/sig/qube_sync/operations/bar_code.rbs +16 -0
  140. data/sig/qube_sync/operations/bill.rbs +78 -0
  141. data/sig/qube_sync/operations/bill_payment_check.rbs +62 -0
  142. data/sig/qube_sync/operations/bill_payment_credit_card.rbs +45 -0
  143. data/sig/qube_sync/operations/bill_to_pay.rbs +19 -0
  144. data/sig/qube_sync/operations/billing_rate.rbs +40 -0
  145. data/sig/qube_sync/operations/budget_summary_report.rbs +22 -0
  146. data/sig/qube_sync/operations/build_assembly.rbs +64 -0
  147. data/sig/qube_sync/operations/charge.rbs +80 -0
  148. data/sig/qube_sync/operations/check.rbs +81 -0
  149. data/sig/qube_sync/operations/class.rbs +43 -0
  150. data/sig/qube_sync/operations/cleared_status.rbs +16 -0
  151. data/sig/qube_sync/operations/company.rbs +15 -0
  152. data/sig/qube_sync/operations/company_activity.rbs +14 -0
  153. data/sig/qube_sync/operations/credit_card_charge.rbs +69 -0
  154. data/sig/qube_sync/operations/credit_card_credit.rbs +69 -0
  155. data/sig/qube_sync/operations/credit_memo.rbs +162 -0
  156. data/sig/qube_sync/operations/currency.rbs +52 -0
  157. data/sig/qube_sync/operations/custom_detail_report.rbs +31 -0
  158. data/sig/qube_sync/operations/custom_summary_report.rbs +33 -0
  159. data/sig/qube_sync/operations/customer.rbs +174 -0
  160. data/sig/qube_sync/operations/customer_msg.rbs +31 -0
  161. data/sig/qube_sync/operations/customer_type.rbs +32 -0
  162. data/sig/qube_sync/operations/data_event_recovery_info.rbs +20 -0
  163. data/sig/qube_sync/operations/data_ext.rbs +53 -0
  164. data/sig/qube_sync/operations/data_ext_def.rbs +51 -0
  165. data/sig/qube_sync/operations/date_driven_terms.rbs +35 -0
  166. data/sig/qube_sync/operations/deposit.rbs +100 -0
  167. data/sig/qube_sync/operations/employee.rbs +173 -0
  168. data/sig/qube_sync/operations/employee_default.rbs +68 -0
  169. data/sig/qube_sync/operations/entity.rbs +24 -0
  170. data/sig/qube_sync/operations/estimate.rbs +148 -0
  171. data/sig/qube_sync/operations/form1099_category_account_mapping.rbs +33 -0
  172. data/sig/qube_sync/operations/general_detail_report.rbs +31 -0
  173. data/sig/qube_sync/operations/general_summary_report.rbs +32 -0
  174. data/sig/qube_sync/operations/host.rbs +19 -0
  175. data/sig/qube_sync/operations/inventory_adjustment.rbs +105 -0
  176. data/sig/qube_sync/operations/inventory_site.rbs +66 -0
  177. data/sig/qube_sync/operations/invoice.rbs +144 -0
  178. data/sig/qube_sync/operations/item.rbs +25 -0
  179. data/sig/qube_sync/operations/item_assemblies_can_build.rbs +15 -0
  180. data/sig/qube_sync/operations/item_discount.rbs +62 -0
  181. data/sig/qube_sync/operations/item_fixed_asset.rbs +97 -0
  182. data/sig/qube_sync/operations/item_group.rbs +62 -0
  183. data/sig/qube_sync/operations/item_inventory.rbs +87 -0
  184. data/sig/qube_sync/operations/item_inventory_assembly.rbs +94 -0
  185. data/sig/qube_sync/operations/item_non_inventory.rbs +64 -0
  186. data/sig/qube_sync/operations/item_other_charge.rbs +59 -0
  187. data/sig/qube_sync/operations/item_payment.rbs +55 -0
  188. data/sig/qube_sync/operations/item_receipt.rbs +71 -0
  189. data/sig/qube_sync/operations/item_sales_tax.rbs +57 -0
  190. data/sig/qube_sync/operations/item_sales_tax_group.rbs +50 -0
  191. data/sig/qube_sync/operations/item_service.rbs +62 -0
  192. data/sig/qube_sync/operations/item_sites.rbs +26 -0
  193. data/sig/qube_sync/operations/item_subtotal.rbs +48 -0
  194. data/sig/qube_sync/operations/job_report.rbs +28 -0
  195. data/sig/qube_sync/operations/job_type.rbs +32 -0
  196. data/sig/qube_sync/operations/journal_entry.rbs +88 -0
  197. data/sig/qube_sync/operations/lead.rbs +91 -0
  198. data/sig/qube_sync/operations/list.rbs +15 -0
  199. data/sig/qube_sync/operations/list_deleted.rbs +17 -0
  200. data/sig/qube_sync/operations/list_display.rbs +21 -0
  201. data/sig/qube_sync/operations/list_merge.rbs +22 -0
  202. data/sig/qube_sync/operations/other_name.rbs +71 -0
  203. data/sig/qube_sync/operations/paycheck.rbs +27 -0
  204. data/sig/qube_sync/operations/payment_method.rbs +33 -0
  205. data/sig/qube_sync/operations/payroll_detail_report.rbs +29 -0
  206. data/sig/qube_sync/operations/payroll_item.rbs +23 -0
  207. data/sig/qube_sync/operations/payroll_item_addition.rbs +48 -0
  208. data/sig/qube_sync/operations/payroll_item_company_contribution.rbs +58 -0
  209. data/sig/qube_sync/operations/payroll_item_deduction.rbs +54 -0
  210. data/sig/qube_sync/operations/payroll_item_direct_deposit.rbs +30 -0
  211. data/sig/qube_sync/operations/payroll_item_non_wage.rbs +23 -0
  212. data/sig/qube_sync/operations/payroll_item_tax.rbs +58 -0
  213. data/sig/qube_sync/operations/payroll_item_wage.rbs +48 -0
  214. data/sig/qube_sync/operations/payroll_item_workers_compensation.rbs +42 -0
  215. data/sig/qube_sync/operations/payroll_last_period.rbs +13 -0
  216. data/sig/qube_sync/operations/payroll_liability_adjustment.rbs +59 -0
  217. data/sig/qube_sync/operations/payroll_liability_check.rbs +27 -0
  218. data/sig/qube_sync/operations/payroll_prior_payment.rbs +48 -0
  219. data/sig/qube_sync/operations/payroll_summary_report.rbs +30 -0
  220. data/sig/qube_sync/operations/payroll_year_to_date_adjustment.rbs +66 -0
  221. data/sig/qube_sync/operations/preferences.rbs +26 -0
  222. data/sig/qube_sync/operations/price_level.rbs +57 -0
  223. data/sig/qube_sync/operations/purchase_order.rbs +159 -0
  224. data/sig/qube_sync/operations/qb_command_exec.rbs +22 -0
  225. data/sig/qube_sync/operations/receive_payment.rbs +102 -0
  226. data/sig/qube_sync/operations/receive_payment_to_deposit.rbs +15 -0
  227. data/sig/qube_sync/operations/sales_order.rbs +153 -0
  228. data/sig/qube_sync/operations/sales_receipt.rbs +139 -0
  229. data/sig/qube_sync/operations/sales_rep.rbs +43 -0
  230. data/sig/qube_sync/operations/sales_tax_code.rbs +49 -0
  231. data/sig/qube_sync/operations/sales_tax_payable.rbs +16 -0
  232. data/sig/qube_sync/operations/sales_tax_payment_check.rbs +64 -0
  233. data/sig/qube_sync/operations/sales_tax_return.rbs +14 -0
  234. data/sig/qube_sync/operations/sales_tax_return_line.rbs +15 -0
  235. data/sig/qube_sync/operations/ship_method.rbs +31 -0
  236. data/sig/qube_sync/operations/special_account.rbs +16 -0
  237. data/sig/qube_sync/operations/special_item.rbs +17 -0
  238. data/sig/qube_sync/operations/standard_terms.rbs +34 -0
  239. data/sig/qube_sync/operations/template.rbs +15 -0
  240. data/sig/qube_sync/operations/terms.rbs +23 -0
  241. data/sig/qube_sync/operations/time_report.rbs +26 -0
  242. data/sig/qube_sync/operations/time_tracking.rbs +57 -0
  243. data/sig/qube_sync/operations/to_do.rbs +59 -0
  244. data/sig/qube_sync/operations/transaction.rbs +39 -0
  245. data/sig/qube_sync/operations/transfer.rbs +47 -0
  246. data/sig/qube_sync/operations/transfer_inventory.rbs +76 -0
  247. data/sig/qube_sync/operations/txn.rbs +15 -0
  248. data/sig/qube_sync/operations/txn_deleted.rbs +17 -0
  249. data/sig/qube_sync/operations/txn_display.rbs +22 -0
  250. data/sig/qube_sync/operations/txn_void.rbs +15 -0
  251. data/sig/qube_sync/operations/types.rbs +434 -0
  252. data/sig/qube_sync/operations/unit_of_measure_set.rbs +51 -0
  253. data/sig/qube_sync/operations/vehicle.rbs +43 -0
  254. data/sig/qube_sync/operations/vehicle_mileage.rbs +38 -0
  255. data/sig/qube_sync/operations/vendor.rbs +142 -0
  256. data/sig/qube_sync/operations/vendor_credit.rbs +70 -0
  257. data/sig/qube_sync/operations/vendor_type.rbs +32 -0
  258. data/sig/qube_sync/operations/workers_comp_code.rbs +52 -0
  259. data/sig/qube_sync/operations.rbs +147 -0
  260. metadata +255 -2
@@ -0,0 +1,356 @@
1
+ # Generated from operations.json by bin/generate-operations: don't edit.
2
+ # frozen_string_literal: true
3
+
4
+ module QubeSync
5
+ module Operations
6
+ # QuickBooks transaction operations, reached as `client.transaction`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class Transaction < Base
9
+ # List transactions: GET /connections/{connection_id}/transactions (`transaction.query`).
10
+ #
11
+ # QuickBooks answers in pages: one webhook per page, each with its `page`, the last with
12
+ # `iteration_state` `done`.
13
+ #
14
+ # Params, sent as the query string:
15
+ # - `currency_filter` (Hash): Filters by the specified currency. Choose at most one of:
16
+ # `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`,
17
+ # `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`,
18
+ # `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`,
19
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
20
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
21
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
22
+ # with each other, not with the other choices.
23
+ # Give at most one of: `list_id`, or `full_name`.
24
+ # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
25
+ # list object. The `full_name` is the name prefixed by the names of each ancestor, for
26
+ # example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
27
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
28
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
29
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
30
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
31
+ # - `include_ret_element` (Array<one of "AccountRef", "Amount", "AmountInHomeCurrency",
32
+ # "CurrencyRef", "EntityRef", "ExchangeRate", "Memo", "RefNumber", "TimeCreated",
33
+ # "TimeModified", "TxnDate", "TxnID", "TxnLineID", "TxnType">)
34
+ # - `iterator` (Boolean): Page through every match: QuBe Sync asks QuickBooks for each page in
35
+ # turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by
36
+ # default, with pages of 100 records; send `iterator=true` with `max_returned` for another
37
+ # size. Off when you send `iterator=false` (every match in one answer) or `max_returned`
38
+ # alone (at most that many, in one answer). It pages a filtered query only: with `txn_id`
39
+ # every match comes back in one answer, so leave `iterator` out.
40
+ # - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
41
+ # count of how many objects could possibly be returned, use the `meta_data` query
42
+ # attribute.) If you include a `max_returned` value, it must be at least 1. The page size,
43
+ # with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap
44
+ # instead: at most this many records come back, in one answer, and QuickBooks doesn't say
45
+ # whether more matched. Choose at most one of: `txn_id`, or the set (`currency_filter`,
46
+ # `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`,
47
+ # `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`,
48
+ # `transaction_date_range_filter`, `transaction_detail_level_filter`,
49
+ # `transaction_entity_filter`, `transaction_item_filter`,
50
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
51
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
52
+ # with each other, not with the other choices.
53
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
54
+ # `meta_data` attribute to control whether query responses include counts. Options are
55
+ # NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
56
+ # objects). Counts are approximate and may vary slightly if records are created or deleted
57
+ # during processing.
58
+ # - `ref_number` (Array<String>): `ref_number` is a user-managed transaction reference (for
59
+ # example, a check number). It can be edited and is not guaranteed to be globally unique.
60
+ # Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks
61
+ # preferences and numbering state. Choose at most one of: `txn_id`, or the set
62
+ # (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`,
63
+ # `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`,
64
+ # `transaction_class_filter`, `transaction_date_range_filter`,
65
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
66
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
67
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
68
+ # with each other, not with the other choices.
69
+ # - `ref_number_case_sensitive` (Array<String>): Choose at most one of: `txn_id`, or the set
70
+ # (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`,
71
+ # `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`,
72
+ # `transaction_class_filter`, `transaction_date_range_filter`,
73
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
74
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
75
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
76
+ # with each other, not with the other choices.
77
+ # - `ref_number_filter` (Hash): Filters by `ref_number` range. Numeric-only bounds are
78
+ # compared numerically; otherwise comparison is lexicographic. Choose at most one of:
79
+ # `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`,
80
+ # `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`,
81
+ # `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`,
82
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
83
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
84
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
85
+ # with each other, not with the other choices.
86
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
87
+ # to match.
88
+ # - `ref_number` (String, required): `ref_number` is a user-managed transaction reference
89
+ # (for example, a check number). It can be edited and is not guaranteed to be globally
90
+ # unique. Some transaction types auto-populate `ref_number` when omitted, based on
91
+ # QuickBooks preferences and numbering state.
92
+ # - `ref_number_range_filter` (Hash): Filters by `ref_number` range. Numeric-only bounds are
93
+ # compared numerically; otherwise comparison is lexicographic. Choose at most one of:
94
+ # `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`,
95
+ # `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`,
96
+ # `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`,
97
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
98
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
99
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
100
+ # with each other, not with the other choices.
101
+ # - `from_ref_number` (String): The first `ref_number` in the search range. If
102
+ # `from_ref_number` is omitted, the range will begin with first number on the list.
103
+ # - `to_ref_number` (String): The final `ref_number` in the search range. If `to_ref_number`
104
+ # is omitted, the range will end with last number on the list.
105
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
106
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
107
+ # webhook already carries the request's `id`.
108
+ # - `transaction_account_filter` (Hash): Filters the transactions based on the `account_ref`
109
+ # in the transaction or transaction line using an account type filter or a specific
110
+ # `list_id`, or a `full_name`, or a `list_id_with_children`, or a `full_name_with_children`.
111
+ # To filter on transaction lines, you must specify the `transaction_detail_level_filter`
112
+ # with a value of either “All” or “AllExceptSummary”. Choose at most one of: `txn_id`, or
113
+ # the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`,
114
+ # `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`,
115
+ # `transaction_class_filter`, `transaction_date_range_filter`,
116
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
117
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
118
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
119
+ # with each other, not with the other choices.
120
+ # Give at most one of: `account_type_filter`, or `list_id`, or `full_name`, or
121
+ # `list_id_with_children`, or `full_name_with_children`.
122
+ # - `account_type_filter` (one of "APAndSalesTax", "APOrCreditCard", "ARAndAP",
123
+ # "AccountsPayable", "AccountsReceivable", "AllowedFor1099", "Asset", "BalanceSheet",
124
+ # "Bank", "BankAndARAndAPAndUF", "BankAndUF", "CostOfSales", "CreditCard", "CurrentAsset",
125
+ # "CurrentAssetAndExpense", "CurrentLiability", "Equity", "EquityAndIncomeAndExpense",
126
+ # "ExpenseAndOtherExpense", "FixedAsset", "IncomeAndExpense", "IncomeAndOtherIncome",
127
+ # "Liability", "LiabilityAndEquity", "LongTermLiability", "NonPosting", "OrdinaryExpense",
128
+ # "OrdinaryIncome", "OrdinaryIncomeAndCOGS", "OrdinaryIncomeAndExpense", "OtherAsset",
129
+ # "OtherCurrentAsset", "OtherCurrentLiability", "OtherExpense", "OtherIncome",
130
+ # "OtherIncomeOrExpense"): Allows you to report on a specific account type.
131
+ # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
132
+ # list object. The `full_name` is the name prefixed by the names of each ancestor, for
133
+ # example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
134
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
135
+ # specified object and its descendants. For names that don’t have children,
136
+ # `full_name_with_children` is exactly the same as `full_name`.
137
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
138
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
139
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
140
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
141
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
142
+ # specified object and its descendants.
143
+ # - `transaction_class_filter` (Hash): Filters the transactions based on the ClassRef in the
144
+ # transaction or transaction line by using a specific `list_id`, or a `full_name`, or a
145
+ # `list_id_with_children`, or a `full_name_with_children`. To filter on transaction lines,
146
+ # you must specify the `transaction_detail_level_filter` with a value of either “All” or
147
+ # “AllExceptSummary”. Choose at most one of: `txn_id`, or the set (`currency_filter`,
148
+ # `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`,
149
+ # `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`,
150
+ # `transaction_date_range_filter`, `transaction_detail_level_filter`,
151
+ # `transaction_entity_filter`, `transaction_item_filter`,
152
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
153
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
154
+ # with each other, not with the other choices.
155
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
156
+ # `full_name_with_children`.
157
+ # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
158
+ # list object. The `full_name` is the name prefixed by the names of each ancestor, for
159
+ # example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
160
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
161
+ # specified object and its descendants. For names that don’t have children,
162
+ # `full_name_with_children` is exactly the same as `full_name`.
163
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
164
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
165
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
166
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
167
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
168
+ # specified object and its descendants.
169
+ # - `transaction_date_range_filter` (Hash): Filters the transactions based on the
170
+ # transaction’s date either by specifying a “from” and/or “to” date, or by using a
171
+ # `date_macro`. Choose at most one of: `txn_id`, or the set (`currency_filter`,
172
+ # `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`,
173
+ # `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`,
174
+ # `transaction_date_range_filter`, `transaction_detail_level_filter`,
175
+ # `transaction_entity_filter`, `transaction_item_filter`,
176
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
177
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
178
+ # with each other, not with the other choices.
179
+ # Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
180
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
181
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
182
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
183
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
184
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
185
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
186
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
187
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
188
+ # "ThisWeekToDate", "Today", "Yesterday"): `date_macro` filters by transaction date (not
189
+ # last-modified date). Do not combine `date_macro` with
190
+ # `from_modified_date`/`to_modified_date` in the same query filter set.
191
+ # - `from_txn_date` (String): Selects transactions created on or after this date. Both
192
+ # `from_txn_date` and `to_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit
193
+ # `from_txn_date`, it will be set to 1970-01-01 (1969-12-31 PST).
194
+ # - `to_txn_date` (String): Selects transactions created on or before this date. Both
195
+ # `to_txn_date` and `from_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit
196
+ # `to_txn_date`, it will be set to 2038-01-19 (2038-01-18 PST).
197
+ # - `transaction_detail_level_filter` (one of "All", "AllExceptSummary", "SummaryOnly"):
198
+ # Allows you to specify the detail level of the query results. You can specify all, summary
199
+ # only (the default), or all except summary. Summary only refers to the transaction as a
200
+ # whole, whereas all except summary refers to the transaction lines. Choose at most one of:
201
+ # `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`,
202
+ # `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`,
203
+ # `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`,
204
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
205
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
206
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
207
+ # with each other, not with the other choices.
208
+ # - `transaction_entity_filter` (Hash): Filters the transactions based on the `entity_ref`
209
+ # used in the transaction or transaction line by specifying an entity type filter, a
210
+ # `list_id`, a `full_name`, a `list_id_with_children`, or a `full_name_with_children`. If
211
+ # you want to filter on transaction lines you must specify the
212
+ # `transaction_detail_level_filter` with a value of either “All” or “AllExceptSummary”.
213
+ # Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`,
214
+ # `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`,
215
+ # `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`,
216
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
217
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
218
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
219
+ # with each other, not with the other choices.
220
+ # Give at most one of: `entity_type_filter`, or `list_id`, or `full_name`, or
221
+ # `list_id_with_children`, or `full_name_with_children`.
222
+ # - `entity_type_filter` (one of "Customer", "Employee", "OtherName", "Vendor"): Allows you
223
+ # to report on a specific name type.
224
+ # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
225
+ # list object. The `full_name` is the name prefixed by the names of each ancestor, for
226
+ # example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
227
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
228
+ # specified object and its descendants. For names that don’t have children,
229
+ # `full_name_with_children` is exactly the same as `full_name`.
230
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
231
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
232
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
233
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
234
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
235
+ # specified object and its descendants.
236
+ # - `transaction_item_filter` (Hash): Filters the transactions based on the ItemRef used in
237
+ # the transaction line using an item type filter, or a specific `list_id`, or a `full_name`,
238
+ # or a `list_id_with_children`, or a `full_name_with_children`. To filter on transaction
239
+ # lines, you must specify the `transaction_detail_level_filter` with a value of either “All”
240
+ # or “AllExceptSummary”. Choose at most one of: `txn_id`, or the set (`currency_filter`,
241
+ # `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`,
242
+ # `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`,
243
+ # `transaction_date_range_filter`, `transaction_detail_level_filter`,
244
+ # `transaction_entity_filter`, `transaction_item_filter`,
245
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
246
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
247
+ # with each other, not with the other choices.
248
+ # Give at most one of: `item_type_filter`, or `list_id`, or `full_name`, or
249
+ # `list_id_with_children`, or `full_name_with_children`.
250
+ # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
251
+ # list object. The `full_name` is the name prefixed by the names of each ancestor, for
252
+ # example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
253
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
254
+ # specified object and its descendants. For names that don’t have children,
255
+ # `full_name_with_children` is exactly the same as `full_name`.
256
+ # - `item_type_filter` (one of "AllExceptFixedAsset", "Assembly", "Discount", "FixedAsset",
257
+ # "Inventory", "InventoryAndAssembly", "NonInventory", "OtherCharge", "Payment", "Sales",
258
+ # "SalesTax", "Service"): Allows you to report on a specific item type.
259
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
260
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
261
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
262
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
263
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
264
+ # specified object and its descendants.
265
+ # - `transaction_modified_date_range_filter` (Hash): Filters the transactions based on the
266
+ # transaction’s modified datetime, either by specifying a “from” and/or “to” date or by
267
+ # using a `date_macro`. Choose at most one of: `txn_id`, or the set (`currency_filter`,
268
+ # `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`,
269
+ # `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`,
270
+ # `transaction_date_range_filter`, `transaction_detail_level_filter`,
271
+ # `transaction_entity_filter`, `transaction_item_filter`,
272
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
273
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
274
+ # with each other, not with the other choices.
275
+ # Give at most one of: `from_modified_date` with `to_modified_date`, or `date_macro`.
276
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
277
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
278
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
279
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
280
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
281
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
282
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
283
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
284
+ # "ThisWeekToDate", "Today", "Yesterday"): `date_macro` filters by transaction date (not
285
+ # last-modified date). Do not combine `date_macro` with
286
+ # `from_modified_date`/`to_modified_date` in the same query filter set.
287
+ # - `from_modified_date` (String): Filters results to objects modified on or after this
288
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
289
+ # date is provided, time defaults to 00:00:00.
290
+ # - `to_modified_date` (String): Filters results to objects modified on or before this
291
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
292
+ # date is provided, time defaults to end-of-day (23:59:59).
293
+ # - `transaction_paid_status_filter` (one of "Closed", "Either", "Open"): This filter allows
294
+ # you to search for “open” transactions, i.e. transactions with a remaining balance (for
295
+ # example, credits not fully applied or invoices not fully paid). Valid values are closed,
296
+ # open, or either, which is the default. Choose at most one of: `txn_id`, or the set
297
+ # (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`,
298
+ # `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`,
299
+ # `transaction_class_filter`, `transaction_date_range_filter`,
300
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
301
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
302
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
303
+ # with each other, not with the other choices.
304
+ # - `transaction_posting_status_filter` (one of "Either", "NonPosting", "Posting"): Allows you
305
+ # to filter transactions based on posting status. Valid values are posting, non-posting, or
306
+ # either. The default is “either.” (Posting status refers to whether QuickBooks records a
307
+ # transaction in one of your account registers.) Choose at most one of: `txn_id`, or the set
308
+ # (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`,
309
+ # `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`,
310
+ # `transaction_class_filter`, `transaction_date_range_filter`,
311
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
312
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
313
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
314
+ # with each other, not with the other choices.
315
+ # - `transaction_type_filter` (Hash): Filters the transactions based on the transaction’s
316
+ # type. You can specify one or more transaction types in the filter. Notice that
317
+ # TimeTracking transactions aren’t supported. If you set the transaction type filter to
318
+ # “All” (or if you don’t set it at all), the query will be searching only those transaction
319
+ # types that are permissible types for the user currently logged in. Choose at most one of:
320
+ # `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`,
321
+ # `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`,
322
+ # `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`,
323
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
324
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
325
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
326
+ # with each other, not with the other choices.
327
+ # - `txn_type_filter` (Array<one of "ARRefundCreditCard", "All", "Bill", "BillPaymentCheck",
328
+ # "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check", "CreditCardCharge",
329
+ # "CreditCardCredit", "CreditMemo", "Deposit", "Estimate", "InventoryAdjustment",
330
+ # "Invoice", "ItemReceipt", "JournalEntry", "LiabilityAdjustment", "Paycheck",
331
+ # "PayrollLiabilityCheck", "PurchaseOrder", "ReceivePayment", "SalesOrder",
332
+ # "SalesReceipt", "SalesTaxPaymentCheck", "Transfer", "VendorCredit", "YTDAdjustment">,
333
+ # required)
334
+ # - `txn_id` (Array<String>): `txn_id` is the unique QuickBooks identifier for a transaction.
335
+ # Use it to reference that transaction in later requests. `txn_id` values are
336
+ # transaction-specific and should not be reused across unrelated transaction types. Choose
337
+ # at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`,
338
+ # `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`,
339
+ # `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`,
340
+ # `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`,
341
+ # `transaction_modified_date_range_filter`, `transaction_paid_status_filter`,
342
+ # `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine
343
+ # with each other, not with the other choices.
344
+ #
345
+ # @param connection_id [String]
346
+ # @param params [Hash] the fields above
347
+ # @param webhook_url [String] where QuBe Sync sends the answer
348
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
349
+ # @return [Hash] the queued request
350
+ # @see https://docs.qubesync.com/api-reference/v2/transactions/list-transactions
351
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
352
+ queue("transaction.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
353
+ end
354
+ end
355
+ end
356
+ end
@@ -0,0 +1,213 @@
1
+ # Generated from operations.json by bin/generate-operations: don't edit.
2
+ # frozen_string_literal: true
3
+
4
+ module QubeSync
5
+ module Operations
6
+ # QuickBooks transfer operations, reached as `client.transfer`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class Transfer < Base
9
+ # Create transfer: POST /connections/{connection_id}/transfers (`transfer.create`).
10
+ #
11
+ # QuickBooks answers in one webhook.
12
+ #
13
+ # Params, sent as the JSON body:
14
+ # - `amount` (Numeric): A monetary amount.
15
+ # - `class_ref` (Hash): Use classes to categorize transactions (for example, by department,
16
+ # location, or work type). Class tracking is off by default in QuickBooks. A `class_ref`
17
+ # points to one class; if both `full_name` and `list_id` are provided, `full_name` is
18
+ # ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you
19
+ # override or clear it on individual lines.
20
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
21
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
22
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
23
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
24
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
25
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
26
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
27
+ # - `def_macro` (String): `def_macro` lets you assign a reusable name to a returned `txn_id`
28
+ # or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK
29
+ # 2.0+.
30
+ # - `include_ret_element` (Array<one of "Amount", "ClassRef", "EditSequence",
31
+ # "FromAccountBalance", "Memo", "TimeCreated", "TimeModified", "ToAccountBalance",
32
+ # "TransferFromAccountRef", "TransferToAccountRef", "TxnDate", "TxnID", "TxnNumber">)
33
+ # - `memo` (String): Additional information.
34
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
35
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
36
+ # webhook already carries the request's `id`.
37
+ # - `transfer_from_account_ref` (Hash): Account that money will be transferred from.
38
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
39
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
40
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
41
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
42
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
43
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
44
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
45
+ # - `transfer_to_account_ref` (Hash): Account that money will be transferred to.
46
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
47
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
48
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
49
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
50
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
51
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
52
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
53
+ # - `txn_date` (String): The date of the transaction. In some cases, if you leave `txn_date`
54
+ # out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved
55
+ # transaction of the same type.
56
+ #
57
+ # @param connection_id [String]
58
+ # @param params [Hash] the fields above
59
+ # @param webhook_url [String] where QuBe Sync sends the answer
60
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
61
+ # @return [Hash] the queued request
62
+ # @see https://docs.qubesync.com/api-reference/v2/transfers/create-transfer
63
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
64
+ queue("transfer.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
65
+ end
66
+
67
+ # List transfers: GET /connections/{connection_id}/transfers (`transfer.query`).
68
+ #
69
+ # QuickBooks answers in pages: one webhook per page, each with its `page`, the last with
70
+ # `iteration_state` `done`.
71
+ #
72
+ # Params, sent as the query string:
73
+ # - `include_ret_element` (Array<one of "Amount", "ClassRef", "EditSequence",
74
+ # "FromAccountBalance", "Memo", "TimeCreated", "TimeModified", "ToAccountBalance",
75
+ # "TransferFromAccountRef", "TransferToAccountRef", "TxnDate", "TxnID", "TxnNumber">)
76
+ # - `iterator` (Boolean): Page through every match: QuBe Sync asks QuickBooks for each page in
77
+ # turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by
78
+ # default, with pages of 100 records; send `iterator=true` with `max_returned` for another
79
+ # size. Off when you send `iterator=false` (every match in one answer) or `max_returned`
80
+ # alone (at most that many, in one answer). It pages a filtered query only: with `txn_id`
81
+ # every match comes back in one answer, so leave `iterator` out.
82
+ # - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
83
+ # count of how many objects could possibly be returned, use the `meta_data` query
84
+ # attribute.) If you include a `max_returned` value, it must be at least 1. The page size,
85
+ # with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap
86
+ # instead: at most this many records come back, in one answer, and QuickBooks doesn't say
87
+ # whether more matched. Choose at most one of: `txn_id`, or the set (`max_returned`,
88
+ # `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each
89
+ # other, not with the other choices.
90
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
91
+ # `meta_data` attribute to control whether query responses include counts. Options are
92
+ # NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
93
+ # objects). Counts are approximate and may vary slightly if records are created or deleted
94
+ # during processing.
95
+ # - `modified_date_range_filter` (Hash): Filters according to the dates when transactions were
96
+ # last modified. The `modified_date_range_filter` aggregate isn’t required to contain any
97
+ # elements, but if it is empty, we recommend that you leave it out altogether. Note that the
98
+ # time portion of the `from_modified_date` and `to_modified_date` fields wasn’t supported in
99
+ # qbXML version 1.0 or 1.1. Choose at most one of: `txn_id`, or the set (`max_returned`,
100
+ # `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each
101
+ # other, not with the other choices.
102
+ # - `from_modified_date` (String): Filters results to objects modified on or after this
103
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
104
+ # date is provided, time defaults to 00:00:00.
105
+ # - `to_modified_date` (String): Filters results to objects modified on or before this
106
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
107
+ # date is provided, time defaults to end-of-day (23:59:59).
108
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
109
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
110
+ # webhook already carries the request's `id`.
111
+ # - `txn_date_range_filter` (Hash): Filters according to the original transaction dates.
112
+ # Choose at most one of: `txn_id`, or the set (`max_returned`, `modified_date_range_filter`,
113
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
114
+ # choices.
115
+ # Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
116
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
117
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
118
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
119
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
120
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
121
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
122
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
123
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
124
+ # "ThisWeekToDate", "Today", "Yesterday"): `date_macro` filters by transaction date (not
125
+ # last-modified date). Do not combine `date_macro` with
126
+ # `from_modified_date`/`to_modified_date` in the same query filter set.
127
+ # - `from_txn_date` (String): Selects transactions created on or after this date. Both
128
+ # `from_txn_date` and `to_txn_date` must be between 01/01/1901 and 12/31/9999.If you omit
129
+ # `from_txn_date`, it will be set to 1970-01-01 (1969-12-31 PST).
130
+ # - `to_txn_date` (String): Selects transactions created on or before this date. Both
131
+ # `to_txn_date` and `from_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit
132
+ # `to_txn_date`, it will be set to 2038-01-19 (2038-01-18 PST).
133
+ # - `txn_id` (Array<String>): `txn_id` is the unique QuickBooks identifier for a transaction.
134
+ # Use it to reference that transaction in later requests. `txn_id` values are
135
+ # transaction-specific and should not be reused across unrelated transaction types. Choose
136
+ # at most one of: `txn_id`, or the set (`max_returned`, `modified_date_range_filter`,
137
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
138
+ # choices.
139
+ #
140
+ # @param connection_id [String]
141
+ # @param params [Hash] the fields above
142
+ # @param webhook_url [String] where QuBe Sync sends the answer
143
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
144
+ # @return [Hash] the queued request
145
+ # @see https://docs.qubesync.com/api-reference/v2/transfers/list-transfers
146
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
147
+ queue("transfer.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
148
+ end
149
+
150
+ # Update transfer: PUT /connections/{connection_id}/transfers (`transfer.update`).
151
+ #
152
+ # QuickBooks answers in one webhook.
153
+ #
154
+ # Params, sent as the JSON body:
155
+ # - `amount` (Numeric): A monetary amount.
156
+ # - `class_ref` (Hash): Use classes to categorize transactions (for example, by department,
157
+ # location, or work type). Class tracking is off by default in QuickBooks. A `class_ref`
158
+ # points to one class; if both `full_name` and `list_id` are provided, `full_name` is
159
+ # ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you
160
+ # override or clear it on individual lines.
161
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
162
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
163
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
164
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
165
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
166
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
167
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
168
+ # - `edit_sequence` (String, required): `edit_sequence` is a server-generated revision token.
169
+ # It changes each time the object is updated. To modify an existing object, you must send
170
+ # the current `edit_sequence`. If your value is stale, the update is rejected to prevent
171
+ # overwriting newer changes.
172
+ # - `include_ret_element` (Array<one of "Amount", "ClassRef", "EditSequence",
173
+ # "FromAccountBalance", "Memo", "TimeCreated", "TimeModified", "ToAccountBalance",
174
+ # "TransferFromAccountRef", "TransferToAccountRef", "TxnDate", "TxnID", "TxnNumber">)
175
+ # - `memo` (String): Additional information.
176
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
177
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
178
+ # webhook already carries the request's `id`.
179
+ # - `transfer_from_account_ref` (Hash): Account that money will be transferred from.
180
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
181
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
182
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
183
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
184
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
185
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
186
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
187
+ # - `transfer_to_account_ref` (Hash): Account that money will be transferred to.
188
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
189
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
190
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
191
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
192
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
193
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
194
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
195
+ # - `txn_date` (String): The date of the transaction. In some cases, if you leave `txn_date`
196
+ # out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved
197
+ # transaction of the same type.
198
+ # - `txn_id` (String, required): `txn_id` is the unique QuickBooks identifier for a
199
+ # transaction. Use it to reference that transaction in later requests. `txn_id` values are
200
+ # transaction-specific and should not be reused across unrelated transaction types.
201
+ #
202
+ # @param connection_id [String]
203
+ # @param params [Hash] the fields above
204
+ # @param webhook_url [String] where QuBe Sync sends the answer
205
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
206
+ # @return [Hash] the queued request
207
+ # @see https://docs.qubesync.com/api-reference/v2/transfers/update-transfer
208
+ def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
209
+ queue("transfer.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
210
+ end
211
+ end
212
+ end
213
+ end