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,161 @@
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 detail report operations, reached as `client.payroll_detail_report`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollDetailReport < Base
9
+ # List payroll detail reports: GET /connections/{connection_id}/payroll-detail-reports
10
+ # (`payroll_detail_report.query`).
11
+ #
12
+ # QuickBooks answers in one webhook.
13
+ #
14
+ # Params, sent as the query string:
15
+ # - `display_report` (Boolean): Set `display_report` to true to display this report within the
16
+ # QuickBooks UI. (Default is false.) If you want the request to display the report without
17
+ # returning any data to your application, set the responseData attribute to includeNone.
18
+ # - `include_accounts` (one of "All", "InUse"): Indicates whether this report should include
19
+ # all accounts or just those that are currently in use.
20
+ # - `include_column` (Array<one of "Account", "Aging", "Amount", "AmountDifference",
21
+ # "AverageCost", "BilledDate", "BillingStatus", "CalculatedAmount", "Class",
22
+ # "ClearedStatus", "CostPrice", "Credit", "Currency", "Date", "Debit", "DeliveryDate",
23
+ # "DueDate", "EstimateActive", "ExchangeRate", "FOB", "IncomeSubjectToTax", "Invoiced",
24
+ # "Item", "ItemDesc", "LastModifiedBy", "LatestOrPriorState", "Memo", "ModifiedTime",
25
+ # "Name", "NameAccountNumber", "NameAddress", "NameCity", "NameContact", "NameEmail",
26
+ # "NameFax", "NamePhone", "NameState", "NameZip", "OpenBalance", "OriginalAmount",
27
+ # "PONumber", "PaidAmount", "PaidStatus", "PaidThroughDate", "PaymentMethod", "PayrollItem",
28
+ # "PrintStatus", "ProgressAmount", "ProgressPercent", "Quantity", "QuantityAvailable",
29
+ # "QuantityOnHand", "QuantityOnSalesOrder", "ReceivedQuantity", "RefNumber",
30
+ # "RunningBalance", "SSNOrTaxID", "SalesRep", "SalesTaxCode", "SerialOrLotNumber",
31
+ # "ShipDate", "ShipMethod", "SourceName", "SplitAccount", "TaxLine", "TaxTableVersion",
32
+ # "Terms", "TxnID", "TxnNumber", "TxnType", "UnitPrice", "UserEdit", "ValueOnHand",
33
+ # "WageBase", "WageBaseTips">)
34
+ # - `payroll_detail_report_type` (one of "EmployeeStateTaxesDetail", "PayrollItemDetail",
35
+ # "PayrollReviewDetail", "PayrollTransactionDetail", "PayrollTransactionsByPayee", required)
36
+ # - `report_account_filter` (Hash): Allows you to query for a specified account type or for
37
+ # specific list elements.
38
+ # Give at most one of: `account_type_filter`, or `list_id`, or `full_name`, or
39
+ # `list_id_with_children`, or `full_name_with_children`.
40
+ # - `account_type_filter` (one of "APAndSalesTax", "APOrCreditCard", "ARAndAP",
41
+ # "AccountsPayable", "AccountsReceivable", "AllowedFor1099", "Asset", "BalanceSheet",
42
+ # "Bank", "BankAndARAndAPAndUF", "BankAndUF", "CostOfSales", "CreditCard", "CurrentAsset",
43
+ # "CurrentAssetAndExpense", "CurrentLiability", "Equity", "EquityAndIncomeAndExpense",
44
+ # "ExpenseAndOtherExpense", "FixedAsset", "IncomeAndExpense", "IncomeAndOtherIncome",
45
+ # "Liability", "LiabilityAndEquity", "LongTermLiability", "NonPosting", "OrdinaryExpense",
46
+ # "OrdinaryIncome", "OrdinaryIncomeAndCOGS", "OrdinaryIncomeAndExpense", "OtherAsset",
47
+ # "OtherCurrentAsset", "OtherCurrentLiability", "OtherExpense", "OtherIncome",
48
+ # "OtherIncomeOrExpense"): Allows you to report on a specific account type.
49
+ # - `full_name` (Array<String>)
50
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
51
+ # specified object and its descendants. For names that don’t have children,
52
+ # `full_name_with_children` is exactly the same as `full_name`.
53
+ # - `list_id` (Array<String>)
54
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
55
+ # specified object and its descendants.
56
+ # - `report_class_filter` (Hash): Allows you to query for a specified class. Classes can be
57
+ # used to separate transactions into meaningful categories. (For example, transactions could
58
+ # be classified according to department, business location, or type of work.) In QuickBooks,
59
+ # class tracking is off by default.
60
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
61
+ # `full_name_with_children`.
62
+ # - `full_name` (Array<String>)
63
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
64
+ # specified object and its descendants. For names that don’t have children,
65
+ # `full_name_with_children` is exactly the same as `full_name`.
66
+ # - `list_id` (Array<String>)
67
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
68
+ # specified object and its descendants.
69
+ # - `report_date_macro` (one of "All", "LastMonth", "LastMonthToDate", "LastQuarter",
70
+ # "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear", "LastYearToDate",
71
+ # "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear", "ThisMonth",
72
+ # "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek", "ThisWeekToDate",
73
+ # "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period covered by this
74
+ # report. Choose at most one of: `report_period`, or `report_date_macro`.
75
+ # - `report_detail_level_filter` (one of "All", "AllExceptSummary", "SummaryOnly"): The level
76
+ # of detail to include in the report.
77
+ # - `report_entity_filter` (Hash): Allows you to query for a specified name type (customer,
78
+ # employee, vendor, or other) or query for specific list elements.
79
+ # Give at most one of: `entity_type_filter`, or `list_id`, or `full_name`, or
80
+ # `list_id_with_children`, or `full_name_with_children`.
81
+ # - `entity_type_filter` (one of "Customer", "Employee", "OtherName", "Vendor"): Allows you
82
+ # to report on a specific name type.
83
+ # - `full_name` (Array<String>)
84
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
85
+ # specified object and its descendants. For names that don’t have children,
86
+ # `full_name_with_children` is exactly the same as `full_name`.
87
+ # - `list_id` (Array<String>)
88
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
89
+ # specified object and its descendants.
90
+ # - `report_item_filter` (Hash): Allows you to query for a specified item type (for example,
91
+ # discount, inventory, or non-inventory) or query for specific list elements.
92
+ # Give at most one of: `item_type_filter`, or `list_id`, or `full_name`, or
93
+ # `list_id_with_children`, or `full_name_with_children`.
94
+ # - `full_name` (Array<String>)
95
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
96
+ # specified object and its descendants. For names that don’t have children,
97
+ # `full_name_with_children` is exactly the same as `full_name`.
98
+ # - `item_type_filter` (one of "AllExceptFixedAsset", "Assembly", "Discount", "FixedAsset",
99
+ # "Inventory", "InventoryAndAssembly", "NonInventory", "OtherCharge", "Payment", "Sales",
100
+ # "SalesTax", "Service"): Allows you to report on a specific item type.
101
+ # - `list_id` (Array<String>)
102
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
103
+ # specified object and its descendants.
104
+ # - `report_modified_date_range_filter` (Hash): Returns reports that were modified between
105
+ # these two dates (inclusive). The range of acceptable dates for both
106
+ # `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to
107
+ # 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). Choose at most one of:
108
+ # `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
109
+ # - `from_report_modified_date` (String): Selects information from this date and later. The
110
+ # range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
111
+ # (2038-01-18T19:14:07-08:00 PST).
112
+ # - `to_report_modified_date` (String): Selects information created on this date or earlier.
113
+ # The range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
114
+ # (2038-01-18T19:14:07-08:00 PST).
115
+ # - `report_modified_date_range_macro` (one of "All", "LastMonth", "LastMonthToDate",
116
+ # "LastQuarter", "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear",
117
+ # "LastYearToDate", "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear",
118
+ # "ThisMonth", "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek",
119
+ # "ThisWeekToDate", "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period
120
+ # covered by this report. Choose at most one of: `report_modified_date_range_filter`, or
121
+ # `report_modified_date_range_macro`.
122
+ # - `report_open_balance_as_of` (one of "ReportEndDate", "Today"): The report will return open
123
+ # balance information up to the `report_open_balance_as_of` date.
124
+ # - `report_period` (Hash): If you omit both `to_report_date` and `from_report_date`, the
125
+ # report will cover the current fiscal year to date. Choose at most one of: `report_period`,
126
+ # or `report_date_macro`.
127
+ # - `from_report_date` (String): Selects information from this date and later. The range of
128
+ # acceptable `from_report_date` and `to_report_date` values depends on how the report
129
+ # dates are determined. If the report dates are based on the dates of transactions, the
130
+ # range is 01/01/1901 to 12/31/9999.
131
+ # - `to_report_date` (String): Selects information created on this date or earlier. The
132
+ # range of acceptable `to_report_date` and `from_report_date` values depends on how the
133
+ # report dates are determined. If the report dates are based on the dates of transactions,
134
+ # the range is 01/01/1901 to 12/31/9999.
135
+ # - `report_posting_status_filter` (one of "Either", "NonPosting", "Posting"): Allows you to
136
+ # query for posting reports, non-posting reports, or reports that are either one.
137
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
138
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
139
+ # webhook already carries the request's `id`.
140
+ # - `summarize_rows_by` (one of "Account", "BalanceSheet", "Class", "Customer",
141
+ # "CustomerType", "Day", "Employee", "FourWeek", "HalfMonth", "IncomeStatement",
142
+ # "ItemDetail", "ItemType", "Month", "Payee", "PaymentMethod", "PayrollItemDetail",
143
+ # "PayrollYtdDetail", "Quarter", "SalesRep", "SalesTaxCode", "ShipMethod", "TaxLine",
144
+ # "Terms", "TotalOnly", "TwoWeek", "Vendor", "VendorType", "Week", "Year"):
145
+ # `summarize_rows_by` (along with IncludeColumnList, in most cases) determines what data is
146
+ # calculated for this report and controls how the rows are organized and labeled. For
147
+ # example, if you set the value to srbAccount, the report’s row labels might be “Checking,”
148
+ # “Savings,” and so on.
149
+ #
150
+ # @param connection_id [String]
151
+ # @param params [Hash] the fields above
152
+ # @param webhook_url [String] where QuBe Sync sends the answer
153
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
154
+ # @return [Hash] the queued request
155
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-detail-reports/list-payroll-detail-reports
156
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
157
+ queue("payroll_detail_report.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
158
+ end
159
+ end
160
+ end
161
+ end
@@ -0,0 +1,75 @@
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 item operations, reached as `client.payroll_item`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollItem < Base
9
+ # List payroll items: GET /connections/{connection_id}/payroll-items (`payroll_item.query`).
10
+ #
11
+ # QuickBooks answers in one webhook.
12
+ #
13
+ # Params, sent as the query string:
14
+ # - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): Choose at most one of:
15
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
16
+ # `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
17
+ # combine with each other, not with the other choices.
18
+ # - `from_modified_date` (String): Choose at most one of: `list_id`, or `full_name`, or the
19
+ # set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
20
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
21
+ # with the other choices.
22
+ # - `full_name` (Array<String>): Choose at most one of: `list_id`, or `full_name`, or the set
23
+ # (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
24
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
25
+ # with the other choices.
26
+ # - `include_ret_element` (Array<one of "CalculatedBasedOn", "EditSequence",
27
+ # "ExpenseAccountRef", "IsActive", "IsTrackedByCustJob", "LiabilityAccountRef",
28
+ # "LiabilityPaymentSchedule", "Limit", "LimitTimePeriod", "ListID", "Name", "NetOrGross",
29
+ # "OvertimeMultiplier", "PaymentTemplateRef", "PayrollItemDetailTypeValue", "Rate",
30
+ # "RateChange", "RatePercent", "State", "TaxCalculatedBasedOn", "Taxability", "TimeCreated",
31
+ # "TimeModified", "VendorAccountNumber", "VendorRef", "W2TrackingTypeValue", "WageType">)
32
+ # - `list_id` (Array<String>): Choose at most one of: `list_id`, or `full_name`, or the set
33
+ # (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
34
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
35
+ # with the other choices.
36
+ # - `max_returned` (Integer): QuickBooks doesn't page this query: at most this many records
37
+ # come back, in one answer, with no sign of whether more matched. Leave it out for every
38
+ # match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML
39
+ # isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
40
+ # Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`,
41
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
42
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
43
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData")
44
+ # - `name_filter` (Hash): Choose at most one of: `list_id`, or `full_name`, or the set
45
+ # (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
46
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
47
+ # with the other choices.
48
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required)
49
+ # - `name` (String, required)
50
+ # - `name_range_filter` (Hash): Choose at most one of: `list_id`, or `full_name`, or the set
51
+ # (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
52
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
53
+ # with the other choices.
54
+ # - `from_name` (String)
55
+ # - `to_name` (String)
56
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
57
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
58
+ # webhook already carries the request's `id`.
59
+ # - `to_modified_date` (String): Choose at most one of: `list_id`, or `full_name`, or the set
60
+ # (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
61
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
62
+ # with the other choices.
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-items/list-payroll-items
70
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
71
+ queue("payroll_item.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,98 @@
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 item addition operations, reached as `client.payroll_item_addition`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollItemAddition < Base
9
+ # Create payroll item addition: POST /connections/{connection_id}/payroll-item-additions
10
+ # (`payroll_item_addition.create`).
11
+ #
12
+ # QuickBooks answers in one webhook.
13
+ #
14
+ # Params, sent as the JSON body:
15
+ # - `calculated_based_on` (one of "HoursAll", "HoursWorked", "Quantity", "Rate")
16
+ # - `expense_account_ref` (Hash, required)
17
+ # - `full_name` (String)
18
+ # - `list_id` (String)
19
+ # - `include_ret_element` (Array<one of "CalculatedBasedOn", "EditSequence",
20
+ # "ExpenseAccountRef", "IsActive", "IsTrackedByCustJob", "Limit", "LimitTimePeriod",
21
+ # "ListID", "Name", "NetOrGross", "PayrollItemDetailTypeValue", "Rate", "RatePercent",
22
+ # "Taxability", "TimeCreated", "TimeModified", "W2TrackingTypeValue">)
23
+ # - `is_active` (Boolean)
24
+ # - `is_tracked_by_cust_job` (Boolean)
25
+ # - `limit` (Numeric)
26
+ # - `limit_time_period` (one of "Annual", "Forever")
27
+ # - `name` (String, required)
28
+ # - `net_or_gross` (one of "Gross", "Net")
29
+ # - `payroll_item_detail_type_value` (Integer)
30
+ # - `rate` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
31
+ # - `rate_percent` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
32
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
33
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
34
+ # webhook already carries the request's `id`.
35
+ # - `taxability` (Array<Hash>)
36
+ # - `is_tax_applied` (Boolean, required)
37
+ # - `payroll_item_tax_ref` (Hash, required)
38
+ # - `full_name` (String)
39
+ # - `list_id` (String)
40
+ # - `w2_tracking_type_value` (Integer)
41
+ #
42
+ # @param connection_id [String]
43
+ # @param params [Hash] the fields above
44
+ # @param webhook_url [String] where QuBe Sync sends the answer
45
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
46
+ # @return [Hash] the queued request
47
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-item-additions/create-payroll-item-addition
48
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
49
+ queue("payroll_item_addition.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
50
+ end
51
+
52
+ # Update payroll item addition: PUT /connections/{connection_id}/payroll-item-additions
53
+ # (`payroll_item_addition.update`).
54
+ #
55
+ # QuickBooks answers in one webhook.
56
+ #
57
+ # Params, sent as the JSON body:
58
+ # - `calculated_based_on` (one of "HoursAll", "HoursWorked", "Quantity", "Rate")
59
+ # - `edit_sequence` (String, required)
60
+ # - `expense_account_ref` (Hash)
61
+ # - `full_name` (String)
62
+ # - `list_id` (String)
63
+ # - `include_ret_element` (Array<one of "CalculatedBasedOn", "EditSequence",
64
+ # "ExpenseAccountRef", "IsActive", "IsTrackedByCustJob", "Limit", "LimitTimePeriod",
65
+ # "ListID", "Name", "NetOrGross", "PayrollItemDetailTypeValue", "Rate", "RatePercent",
66
+ # "Taxability", "TimeCreated", "TimeModified", "W2TrackingTypeValue">)
67
+ # - `is_active` (Boolean)
68
+ # - `is_tracked_by_cust_job` (Boolean)
69
+ # - `limit` (Numeric)
70
+ # - `limit_time_period` (one of "Annual", "Forever")
71
+ # - `list_id` (String, required)
72
+ # - `name` (String)
73
+ # - `net_or_gross` (one of "Gross", "Net")
74
+ # - `payroll_item_detail_type_value` (Integer)
75
+ # - `rate` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
76
+ # - `rate_percent` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
77
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
78
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
79
+ # webhook already carries the request's `id`.
80
+ # - `taxability` (Array<Hash>)
81
+ # - `is_tax_applied` (Boolean, required)
82
+ # - `payroll_item_tax_ref` (Hash, required)
83
+ # - `full_name` (String)
84
+ # - `list_id` (String)
85
+ # - `w2_tracking_type_value` (Integer)
86
+ #
87
+ # @param connection_id [String]
88
+ # @param params [Hash] the fields above
89
+ # @param webhook_url [String] where QuBe Sync sends the answer
90
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
91
+ # @return [Hash] the queued request
92
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-item-additions/update-payroll-item-addition
93
+ def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
94
+ queue("payroll_item_addition.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
95
+ end
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,134 @@
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 item company contribution operations, reached as `client.payroll_item_company_contribution`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollItemCompanyContribution < Base
9
+ # Create payroll item company contribution: POST
10
+ # /connections/{connection_id}/payroll-item-company-contributions
11
+ # (`payroll_item_company_contribution.create`).
12
+ #
13
+ # QuickBooks answers in one webhook.
14
+ #
15
+ # Params, sent as the JSON body:
16
+ # - `calculated_based_on` (one of "HoursAll", "HoursWorked", "Quantity", "Rate")
17
+ # - `expense_account_ref` (Hash, required)
18
+ # - `full_name` (String)
19
+ # - `list_id` (String)
20
+ # - `include_ret_element` (Array<one of "CalculatedBasedOn", "EditSequence",
21
+ # "ExpenseAccountRef", "IsActive", "IsTrackedByCustJob", "LiabilityAccountRef",
22
+ # "LiabilityPaymentSchedule", "Limit", "LimitTimePeriod", "ListID", "Name", "NetOrGross",
23
+ # "PaymentTemplateRef", "PayrollItemDetailTypeValue", "Rate", "RatePercent", "Taxability",
24
+ # "TimeCreated", "TimeModified", "VendorAccountNumber", "VendorRef", "W2TrackingTypeValue">)
25
+ # - `is_active` (Boolean)
26
+ # - `is_tracked_by_cust_job` (Boolean)
27
+ # - `liability_account_ref` (Hash, required)
28
+ # - `full_name` (String)
29
+ # - `list_id` (String)
30
+ # - `liability_payment_schedule` (Hash)
31
+ # - `payment_due_date` (String)
32
+ # - `payment_due_num_days_after` (Integer)
33
+ # - `payment_schedule_type` (one of "Empty", "FederalMonthly", "FederalNextDay",
34
+ # "FederalQuarterly", "FederalSemiweekly", "Monthly", "Quarterly", "Semiweekly", "Weekly",
35
+ # "Yearly", required)
36
+ # - `limit` (Numeric)
37
+ # - `limit_time_period` (one of "Annual", "Forever")
38
+ # - `name` (String, required)
39
+ # - `net_or_gross` (one of "Gross", "Net")
40
+ # - `payment_template_ref` (Hash, required)
41
+ # - `full_name` (String)
42
+ # - `list_id` (String)
43
+ # - `payroll_item_detail_type_value` (Integer)
44
+ # - `rate` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
45
+ # - `rate_percent` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
46
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
47
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
48
+ # webhook already carries the request's `id`.
49
+ # - `taxability` (Array<Hash>)
50
+ # - `is_tax_applied` (Boolean, required)
51
+ # - `payroll_item_tax_ref` (Hash, required)
52
+ # - `full_name` (String)
53
+ # - `list_id` (String)
54
+ # - `vendor_account_number` (String)
55
+ # - `vendor_ref` (Hash)
56
+ # - `full_name` (String)
57
+ # - `list_id` (String)
58
+ # - `w2_tracking_type_value` (Integer)
59
+ #
60
+ # @param connection_id [String]
61
+ # @param params [Hash] the fields above
62
+ # @param webhook_url [String] where QuBe Sync sends the answer
63
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
64
+ # @return [Hash] the queued request
65
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-item-company-contributions/create-payroll-item-company-contribution
66
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
67
+ queue("payroll_item_company_contribution.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
68
+ end
69
+
70
+ # Update payroll item company contribution: PUT
71
+ # /connections/{connection_id}/payroll-item-company-contributions
72
+ # (`payroll_item_company_contribution.update`).
73
+ #
74
+ # QuickBooks answers in one webhook.
75
+ #
76
+ # Params, sent as the JSON body:
77
+ # - `calculated_based_on` (one of "HoursAll", "HoursWorked", "Quantity", "Rate")
78
+ # - `edit_sequence` (String, required)
79
+ # - `expense_account_ref` (Hash)
80
+ # - `full_name` (String)
81
+ # - `list_id` (String)
82
+ # - `include_ret_element` (Array<one of "CalculatedBasedOn", "EditSequence",
83
+ # "ExpenseAccountRef", "IsActive", "IsTrackedByCustJob", "LiabilityAccountRef",
84
+ # "LiabilityPaymentSchedule", "Limit", "LimitTimePeriod", "ListID", "Name", "NetOrGross",
85
+ # "PaymentTemplateRef", "PayrollItemDetailTypeValue", "Rate", "RatePercent", "Taxability",
86
+ # "TimeCreated", "TimeModified", "VendorAccountNumber", "VendorRef", "W2TrackingTypeValue">)
87
+ # - `is_active` (Boolean)
88
+ # - `is_tracked_by_cust_job` (Boolean)
89
+ # - `liability_account_ref` (Hash)
90
+ # - `full_name` (String)
91
+ # - `list_id` (String)
92
+ # - `liability_payment_schedule` (Hash)
93
+ # - `payment_due_date` (String)
94
+ # - `payment_due_num_days_after` (Integer)
95
+ # - `payment_schedule_type` (one of "Empty", "FederalMonthly", "FederalNextDay",
96
+ # "FederalQuarterly", "FederalSemiweekly", "Monthly", "Quarterly", "Semiweekly", "Weekly",
97
+ # "Yearly", required)
98
+ # - `limit` (Numeric)
99
+ # - `limit_time_period` (one of "Annual", "Forever")
100
+ # - `list_id` (String, required)
101
+ # - `name` (String)
102
+ # - `net_or_gross` (one of "Gross", "Net")
103
+ # - `payment_template_ref` (Hash)
104
+ # - `full_name` (String)
105
+ # - `list_id` (String)
106
+ # - `payroll_item_detail_type_value` (Integer)
107
+ # - `rate` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
108
+ # - `rate_percent` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
109
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
110
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
111
+ # webhook already carries the request's `id`.
112
+ # - `taxability` (Array<Hash>)
113
+ # - `is_tax_applied` (Boolean, required)
114
+ # - `payroll_item_tax_ref` (Hash, required)
115
+ # - `full_name` (String)
116
+ # - `list_id` (String)
117
+ # - `vendor_account_number` (String)
118
+ # - `vendor_ref` (Hash)
119
+ # - `full_name` (String)
120
+ # - `list_id` (String)
121
+ # - `w2_tracking_type_value` (Integer)
122
+ #
123
+ # @param connection_id [String]
124
+ # @param params [Hash] the fields above
125
+ # @param webhook_url [String] where QuBe Sync sends the answer
126
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
127
+ # @return [Hash] the queued request
128
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-item-company-contributions/update-payroll-item-company-contribution
129
+ def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
130
+ queue("payroll_item_company_contribution.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
131
+ end
132
+ end
133
+ end
134
+ end
@@ -0,0 +1,124 @@
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 item deduction operations, reached as `client.payroll_item_deduction`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PayrollItemDeduction < Base
9
+ # Create payroll item deduction: POST /connections/{connection_id}/payroll-item-deductions
10
+ # (`payroll_item_deduction.create`).
11
+ #
12
+ # QuickBooks answers in one webhook.
13
+ #
14
+ # Params, sent as the JSON body:
15
+ # - `calculated_based_on` (one of "HoursAll", "HoursWorked", "Quantity", "Rate")
16
+ # - `include_ret_element` (Array<one of "CalculatedBasedOn", "EditSequence", "IsActive",
17
+ # "LiabilityAccountRef", "LiabilityPaymentSchedule", "Limit", "LimitTimePeriod", "ListID",
18
+ # "Name", "NetOrGross", "PaymentTemplateRef", "PayrollItemDetailTypeValue", "Rate",
19
+ # "RatePercent", "Taxability", "TimeCreated", "TimeModified", "VendorAccountNumber",
20
+ # "VendorRef", "W2TrackingTypeValue">)
21
+ # - `is_active` (Boolean)
22
+ # - `liability_account_ref` (Hash, required)
23
+ # - `full_name` (String)
24
+ # - `list_id` (String)
25
+ # - `liability_payment_schedule` (Hash)
26
+ # - `payment_due_date` (String)
27
+ # - `payment_due_num_days_after` (Integer)
28
+ # - `payment_schedule_type` (one of "Empty", "FederalMonthly", "FederalNextDay",
29
+ # "FederalQuarterly", "FederalSemiweekly", "Monthly", "Quarterly", "Semiweekly", "Weekly",
30
+ # "Yearly", required)
31
+ # - `limit` (Numeric)
32
+ # - `limit_time_period` (one of "Annual", "Forever")
33
+ # - `name` (String, required)
34
+ # - `net_or_gross` (one of "Gross", "Net")
35
+ # - `payment_template_ref` (Hash, required)
36
+ # - `full_name` (String)
37
+ # - `list_id` (String)
38
+ # - `payroll_item_detail_type_value` (Integer)
39
+ # - `rate` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
40
+ # - `rate_percent` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
41
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
42
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
43
+ # webhook already carries the request's `id`.
44
+ # - `taxability` (Array<Hash>)
45
+ # - `is_tax_applied` (Boolean, required)
46
+ # - `payroll_item_tax_ref` (Hash, required)
47
+ # - `full_name` (String)
48
+ # - `list_id` (String)
49
+ # - `vendor_account_number` (String)
50
+ # - `vendor_ref` (Hash)
51
+ # - `full_name` (String)
52
+ # - `list_id` (String)
53
+ # - `w2_tracking_type_value` (Integer)
54
+ #
55
+ # @param connection_id [String]
56
+ # @param params [Hash] the fields above
57
+ # @param webhook_url [String] where QuBe Sync sends the answer
58
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
59
+ # @return [Hash] the queued request
60
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-item-deductions/create-payroll-item-deduction
61
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
62
+ queue("payroll_item_deduction.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
63
+ end
64
+
65
+ # Update payroll item deduction: PUT /connections/{connection_id}/payroll-item-deductions
66
+ # (`payroll_item_deduction.update`).
67
+ #
68
+ # QuickBooks answers in one webhook.
69
+ #
70
+ # Params, sent as the JSON body:
71
+ # - `calculated_based_on` (one of "HoursAll", "HoursWorked", "Quantity", "Rate")
72
+ # - `edit_sequence` (String, required)
73
+ # - `include_ret_element` (Array<one of "CalculatedBasedOn", "EditSequence", "IsActive",
74
+ # "LiabilityAccountRef", "LiabilityPaymentSchedule", "Limit", "LimitTimePeriod", "ListID",
75
+ # "Name", "NetOrGross", "PaymentTemplateRef", "PayrollItemDetailTypeValue", "Rate",
76
+ # "RatePercent", "Taxability", "TimeCreated", "TimeModified", "VendorAccountNumber",
77
+ # "VendorRef", "W2TrackingTypeValue">)
78
+ # - `is_active` (Boolean)
79
+ # - `liability_account_ref` (Hash)
80
+ # - `full_name` (String)
81
+ # - `list_id` (String)
82
+ # - `liability_payment_schedule` (Hash)
83
+ # - `payment_due_date` (String)
84
+ # - `payment_due_num_days_after` (Integer)
85
+ # - `payment_schedule_type` (one of "Empty", "FederalMonthly", "FederalNextDay",
86
+ # "FederalQuarterly", "FederalSemiweekly", "Monthly", "Quarterly", "Semiweekly", "Weekly",
87
+ # "Yearly", required)
88
+ # - `limit` (Numeric)
89
+ # - `limit_time_period` (one of "Annual", "Forever")
90
+ # - `list_id` (String, required)
91
+ # - `name` (String)
92
+ # - `net_or_gross` (one of "Gross", "Net")
93
+ # - `payment_template_ref` (Hash)
94
+ # - `full_name` (String)
95
+ # - `list_id` (String)
96
+ # - `payroll_item_detail_type_value` (Integer)
97
+ # - `rate` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
98
+ # - `rate_percent` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
99
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
100
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
101
+ # webhook already carries the request's `id`.
102
+ # - `taxability` (Array<Hash>)
103
+ # - `is_tax_applied` (Boolean, required)
104
+ # - `payroll_item_tax_ref` (Hash, required)
105
+ # - `full_name` (String)
106
+ # - `list_id` (String)
107
+ # - `vendor_account_number` (String)
108
+ # - `vendor_ref` (Hash)
109
+ # - `full_name` (String)
110
+ # - `list_id` (String)
111
+ # - `w2_tracking_type_value` (Integer)
112
+ #
113
+ # @param connection_id [String]
114
+ # @param params [Hash] the fields above
115
+ # @param webhook_url [String] where QuBe Sync sends the answer
116
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
117
+ # @return [Hash] the queued request
118
+ # @see https://docs.qubesync.com/api-reference/v2/payroll-item-deductions/update-payroll-item-deduction
119
+ def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
120
+ queue("payroll_item_deduction.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
121
+ end
122
+ end
123
+ end
124
+ end