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,204 @@
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 payroll liability adjustment operations, reached as `client.payroll_liability_adjustment`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollLiabilityAdjustment < Base
9
+ # Create payroll liability adjustment: POST
10
+ # /connections/{connection_id}/payroll-liability-adjustments
11
+ # (`payroll_liability_adjustment.create`).
12
+ #
13
+ # QuickBooks answers in one webhook.
14
+ #
15
+ # Params, sent as the JSON body:
16
+ # - `account_ref` (Hash)
17
+ # - `full_name` (String)
18
+ # - `list_id` (String)
19
+ # - `class_ref` (Hash)
20
+ # - `full_name` (String)
21
+ # - `list_id` (String)
22
+ # - `def_macro` (String)
23
+ # - `employee_ref` (Hash)
24
+ # - `full_name` (String)
25
+ # - `list_id` (String)
26
+ # - `include_ret_element` (Array<one of "AccountRef", "Amount", "ClassRef", "EditSequence",
27
+ # "EmployeeRef", "IsAffectingAccounts", "Memo", "PayrollDate",
28
+ # "PayrollLiabilityAdjustmentLineRet", "RefNumber", "TaxTableVersion", "TimeCreated",
29
+ # "TimeModified", "TxnDate", "TxnID", "TxnNumber">)
30
+ # - `is_affecting_accounts` (Boolean, required)
31
+ # - `memo` (String)
32
+ # - `payroll_date` (String)
33
+ # - `payroll_liability_adjustment_line_add` (Array<Hash>, required)
34
+ # - `account_ref` (Hash)
35
+ # - `full_name` (String)
36
+ # - `list_id` (String)
37
+ # - `amount` (Numeric)
38
+ # - `class_ref` (Hash)
39
+ # - `full_name` (String)
40
+ # - `list_id` (String)
41
+ # - `company_paid_attribute` (one of "IsExpense", "IsLiability", "IsLiabilityAndExpense",
42
+ # "NotApplicable")
43
+ # - `experience_mod_rate_amount` (Numeric)
44
+ # - `income_subject_to_tax_amount` (Numeric)
45
+ # - `memo` (String)
46
+ # - `other_account_ref` (Hash)
47
+ # - `full_name` (String)
48
+ # - `list_id` (String)
49
+ # - `payroll_item_ref` (Hash)
50
+ # - `full_name` (String)
51
+ # - `list_id` (String)
52
+ # - `wage_base_amount` (Numeric)
53
+ # - `workers_comp_amount` (Numeric)
54
+ # - `workers_comp_code_ref` (Hash)
55
+ # - `full_name` (String)
56
+ # - `list_id` (String)
57
+ # - `ref_number` (String)
58
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
59
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
60
+ # webhook already carries the request's `id`.
61
+ # - `tax_table_version` (Integer)
62
+ # - `txn_date` (String)
63
+ #
64
+ # @param connection_id [String]
65
+ # @param params [Hash] the fields above
66
+ # @param webhook_url [String] where QuBe Sync sends the answer
67
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
68
+ # @return [Hash] the queued request
69
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-liability-adjustments/create-payroll-liability-adjustment
70
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
71
+ queue("payroll_liability_adjustment.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
72
+ end
73
+
74
+ # List payroll liability adjustments: GET
75
+ # /connections/{connection_id}/payroll-liability-adjustments
76
+ # (`payroll_liability_adjustment.query`).
77
+ #
78
+ # QuickBooks answers in one webhook.
79
+ #
80
+ # Params, sent as the query string:
81
+ # - `account_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
82
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
83
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
84
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
85
+ # combine with each other, not with the other choices.
86
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
87
+ # `full_name_with_children`.
88
+ # - `full_name` (Array<String>)
89
+ # - `full_name_with_children` (String)
90
+ # - `list_id` (Array<String>)
91
+ # - `list_id_with_children` (String)
92
+ # - `entity_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
93
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
94
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
95
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
96
+ # combine with each other, not with the other choices.
97
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
98
+ # `full_name_with_children`.
99
+ # - `full_name` (Array<String>)
100
+ # - `full_name_with_children` (String)
101
+ # - `list_id` (Array<String>)
102
+ # - `list_id_with_children` (String)
103
+ # - `include_line_items` (Boolean)
104
+ # - `include_ret_element` (Array<one of "AccountRef", "Amount", "ClassRef", "EditSequence",
105
+ # "EmployeeRef", "IsAffectingAccounts", "Memo", "PayrollDate",
106
+ # "PayrollLiabilityAdjustmentLineRet", "RefNumber", "TaxTableVersion", "TimeCreated",
107
+ # "TimeModified", "TxnDate", "TxnID", "TxnNumber">)
108
+ # - `max_returned` (Integer): QuickBooks doesn't page this query: at most this many records
109
+ # come back, in one answer, with no sign of whether more matched. Leave it out for every
110
+ # match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML
111
+ # isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
112
+ # Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the
113
+ # set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
114
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
115
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
116
+ # choices.
117
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData")
118
+ # - `modified_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
119
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
120
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
121
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
122
+ # combine with each other, not with the other choices.
123
+ # - `from_modified_date` (String)
124
+ # - `to_modified_date` (String)
125
+ # - `payroll_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
126
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
127
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
128
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
129
+ # combine with each other, not with the other choices.
130
+ # Give at most one of: `from_payroll_date` with `to_payroll_date`, or `date_macro`.
131
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
132
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
133
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
134
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
135
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
136
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
137
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
138
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
139
+ # "ThisWeekToDate", "Today", "Yesterday")
140
+ # - `from_payroll_date` (String)
141
+ # - `to_payroll_date` (String)
142
+ # - `ref_number` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
143
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
144
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
145
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
146
+ # combine with each other, not with the other choices.
147
+ # - `ref_number_case_sensitive` (Array<String>): Choose at most one of: `txn_id`, or
148
+ # `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
149
+ # `entity_filter`, `max_returned`, `modified_date_range_filter`,
150
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
151
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
152
+ # choices.
153
+ # - `ref_number_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
154
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
155
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
156
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
157
+ # combine with each other, not with the other choices.
158
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required)
159
+ # - `ref_number` (String, required)
160
+ # - `ref_number_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
161
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
162
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
163
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
164
+ # combine with each other, not with the other choices.
165
+ # - `from_ref_number` (String)
166
+ # - `to_ref_number` (String)
167
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
168
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
169
+ # webhook already carries the request's `id`.
170
+ # - `txn_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
171
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
172
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
173
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
174
+ # combine with each other, not with the other choices.
175
+ # Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
176
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
177
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
178
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
179
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
180
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
181
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
182
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
183
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
184
+ # "ThisWeekToDate", "Today", "Yesterday")
185
+ # - `from_txn_date` (String)
186
+ # - `to_txn_date` (String)
187
+ # - `txn_id` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
188
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
189
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
190
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
191
+ # combine with each other, not with the other choices.
192
+ #
193
+ # @param connection_id [String]
194
+ # @param params [Hash] the fields above
195
+ # @param webhook_url [String] where QuBe Sync sends the answer
196
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
197
+ # @return [Hash] the queued request
198
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-liability-adjustments/list-payroll-liability-adjustments
199
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
200
+ queue("payroll_liability_adjustment.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
201
+ end
202
+ end
203
+ end
204
+ end
@@ -0,0 +1,137 @@
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 payroll liability check operations, reached as `client.payroll_liability_check`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollLiabilityCheck < Base
9
+ # List payroll liability checks: GET /connections/{connection_id}/payroll-liability-checks
10
+ # (`payroll_liability_check.query`).
11
+ #
12
+ # QuickBooks answers in one webhook.
13
+ #
14
+ # Params, sent as the query string:
15
+ # - `account_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
16
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
17
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
18
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
19
+ # combine with each other, not with the other choices.
20
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
21
+ # `full_name_with_children`.
22
+ # - `full_name` (Array<String>)
23
+ # - `full_name_with_children` (String)
24
+ # - `list_id` (Array<String>)
25
+ # - `list_id_with_children` (String)
26
+ # - `entity_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
27
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
28
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
29
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
30
+ # combine with each other, not with the other choices.
31
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
32
+ # `full_name_with_children`.
33
+ # - `full_name` (Array<String>)
34
+ # - `full_name_with_children` (String)
35
+ # - `list_id` (Array<String>)
36
+ # - `list_id_with_children` (String)
37
+ # - `include_line_items` (Boolean)
38
+ # - `include_ret_element` (Array<one of "AccountRef", "Address", "Amount", "EditSequence",
39
+ # "IsToBePrinted", "Memo", "PayrollDate", "PayrollLiabilityCheckLineRet", "RefNumber",
40
+ # "TimeCreated", "TimeModified", "TxnDate", "TxnID", "TxnNumber", "VendorRef">)
41
+ # - `max_returned` (Integer): QuickBooks doesn't page this query: at most this many records
42
+ # come back, in one answer, with no sign of whether more matched. Leave it out for every
43
+ # match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML
44
+ # isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
45
+ # Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the
46
+ # set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
47
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
48
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
49
+ # choices.
50
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData")
51
+ # - `modified_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
52
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
53
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
54
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
55
+ # combine with each other, not with the other choices.
56
+ # - `from_modified_date` (String)
57
+ # - `to_modified_date` (String)
58
+ # - `payroll_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
59
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
60
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
61
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
62
+ # combine with each other, not with the other choices.
63
+ # Give at most one of: `from_payroll_date` with `to_payroll_date`, or `date_macro`.
64
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
65
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
66
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
67
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
68
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
69
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
70
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
71
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
72
+ # "ThisWeekToDate", "Today", "Yesterday")
73
+ # - `from_payroll_date` (String)
74
+ # - `to_payroll_date` (String)
75
+ # - `ref_number` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
76
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
77
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
78
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
79
+ # combine with each other, not with the other choices.
80
+ # - `ref_number_case_sensitive` (Array<String>): Choose at most one of: `txn_id`, or
81
+ # `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
82
+ # `entity_filter`, `max_returned`, `modified_date_range_filter`,
83
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
84
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
85
+ # choices.
86
+ # - `ref_number_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
87
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
88
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
89
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
90
+ # combine with each other, not with the other choices.
91
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required)
92
+ # - `ref_number` (String, required)
93
+ # - `ref_number_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
94
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
95
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
96
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
97
+ # combine with each other, not with the other choices.
98
+ # - `from_ref_number` (String)
99
+ # - `to_ref_number` (String)
100
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
101
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
102
+ # webhook already carries the request's `id`.
103
+ # - `txn_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
104
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
105
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
106
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
107
+ # combine with each other, not with the other choices.
108
+ # Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
109
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
110
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
111
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
112
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
113
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
114
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
115
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
116
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
117
+ # "ThisWeekToDate", "Today", "Yesterday")
118
+ # - `from_txn_date` (String)
119
+ # - `to_txn_date` (String)
120
+ # - `txn_id` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
121
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
122
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
123
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
124
+ # combine with each other, not with the other choices.
125
+ #
126
+ # @param connection_id [String]
127
+ # @param params [Hash] the fields above
128
+ # @param webhook_url [String] where QuBe Sync sends the answer
129
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
130
+ # @return [Hash] the queued request
131
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-liability-checks/list-payroll-liability-checks
132
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
133
+ queue("payroll_liability_check.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
134
+ end
135
+ end
136
+ end
137
+ end
@@ -0,0 +1,178 @@
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 payroll prior payment operations, reached as `client.payroll_prior_payment`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollPriorPayment < Base
9
+ # Create payroll prior payment: POST /connections/{connection_id}/payroll-prior-payments
10
+ # (`payroll_prior_payment.create`).
11
+ #
12
+ # QuickBooks answers in one webhook.
13
+ #
14
+ # Params, sent as the JSON body:
15
+ # - `account_ref` (Hash)
16
+ # - `full_name` (String)
17
+ # - `list_id` (String)
18
+ # - `def_macro` (String)
19
+ # - `include_ret_element` (Array<one of "AccountRef", "Amount", "EditSequence",
20
+ # "IsAffectingAccounts", "Memo", "PayrollDate", "PayrollPriorPaymentLineRet", "RefNumber",
21
+ # "TimeCreated", "TimeModified", "TxnDate", "TxnID", "TxnNumber">)
22
+ # - `is_affecting_accounts` (Boolean, required)
23
+ # - `memo` (String)
24
+ # - `payroll_date` (String)
25
+ # - `payroll_prior_payment_line_add` (Array<Hash>, required)
26
+ # - `account_ref` (Hash)
27
+ # - `full_name` (String)
28
+ # - `list_id` (String)
29
+ # - `amount` (Numeric)
30
+ # - `memo` (String)
31
+ # - `payroll_item_ref` (Hash)
32
+ # - `full_name` (String)
33
+ # - `list_id` (String)
34
+ # - `ref_number` (String)
35
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
36
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
37
+ # webhook already carries the request's `id`.
38
+ # - `txn_date` (String)
39
+ #
40
+ # @param connection_id [String]
41
+ # @param params [Hash] the fields above
42
+ # @param webhook_url [String] where QuBe Sync sends the answer
43
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
44
+ # @return [Hash] the queued request
45
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-prior-payments/create-payroll-prior-payment
46
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
47
+ queue("payroll_prior_payment.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
48
+ end
49
+
50
+ # List payroll prior payments: GET /connections/{connection_id}/payroll-prior-payments
51
+ # (`payroll_prior_payment.query`).
52
+ #
53
+ # QuickBooks answers in one webhook.
54
+ #
55
+ # Params, sent as the query string:
56
+ # - `account_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
57
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
58
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
59
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
60
+ # combine with each other, not with the other choices.
61
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
62
+ # `full_name_with_children`.
63
+ # - `full_name` (Array<String>)
64
+ # - `full_name_with_children` (String)
65
+ # - `list_id` (Array<String>)
66
+ # - `list_id_with_children` (String)
67
+ # - `entity_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
68
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
69
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
70
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
71
+ # combine with each other, not with the other choices.
72
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
73
+ # `full_name_with_children`.
74
+ # - `full_name` (Array<String>)
75
+ # - `full_name_with_children` (String)
76
+ # - `list_id` (Array<String>)
77
+ # - `list_id_with_children` (String)
78
+ # - `include_line_items` (Boolean)
79
+ # - `include_ret_element` (Array<one of "AccountRef", "Amount", "EditSequence",
80
+ # "IsAffectingAccounts", "Memo", "PayrollDate", "PayrollPriorPaymentLineRet", "RefNumber",
81
+ # "TimeCreated", "TimeModified", "TxnDate", "TxnID", "TxnNumber">)
82
+ # - `max_returned` (Integer): QuickBooks doesn't page this query: at most this many records
83
+ # come back, in one answer, with no sign of whether more matched. Leave it out for every
84
+ # match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML
85
+ # isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
86
+ # Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the
87
+ # set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
88
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
89
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
90
+ # choices.
91
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData")
92
+ # - `modified_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
93
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
94
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
95
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
96
+ # combine with each other, not with the other choices.
97
+ # - `from_modified_date` (String)
98
+ # - `to_modified_date` (String)
99
+ # - `payroll_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
100
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
101
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
102
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
103
+ # combine with each other, not with the other choices.
104
+ # Give at most one of: `from_payroll_date` with `to_payroll_date`, or `date_macro`.
105
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
106
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
107
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
108
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
109
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
110
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
111
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
112
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
113
+ # "ThisWeekToDate", "Today", "Yesterday")
114
+ # - `from_payroll_date` (String)
115
+ # - `to_payroll_date` (String)
116
+ # - `ref_number` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
117
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
118
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
119
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
120
+ # combine with each other, not with the other choices.
121
+ # - `ref_number_case_sensitive` (Array<String>): Choose at most one of: `txn_id`, or
122
+ # `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
123
+ # `entity_filter`, `max_returned`, `modified_date_range_filter`,
124
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
125
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
126
+ # choices.
127
+ # - `ref_number_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
128
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
129
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
130
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
131
+ # combine with each other, not with the other choices.
132
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required)
133
+ # - `ref_number` (String, required)
134
+ # - `ref_number_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
135
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
136
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
137
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
138
+ # combine with each other, not with the other choices.
139
+ # - `from_ref_number` (String)
140
+ # - `to_ref_number` (String)
141
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
142
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
143
+ # webhook already carries the request's `id`.
144
+ # - `txn_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
145
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
146
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
147
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
148
+ # combine with each other, not with the other choices.
149
+ # Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
150
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
151
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
152
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
153
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
154
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
155
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
156
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
157
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
158
+ # "ThisWeekToDate", "Today", "Yesterday")
159
+ # - `from_txn_date` (String)
160
+ # - `to_txn_date` (String)
161
+ # - `txn_id` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
162
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
163
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
164
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
165
+ # combine with each other, not with the other choices.
166
+ #
167
+ # @param connection_id [String]
168
+ # @param params [Hash] the fields above
169
+ # @param webhook_url [String] where QuBe Sync sends the answer
170
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
171
+ # @return [Hash] the queued request
172
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-prior-payments/list-payroll-prior-payments
173
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
174
+ queue("payroll_prior_payment.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
175
+ end
176
+ end
177
+ end
178
+ end