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,337 @@
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 account operations, reached as `client.account`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class Account < Base
9
+ # Create account: POST /connections/{connection_id}/accounts (`account.create`).
10
+ #
11
+ # QuickBooks answers in one webhook.
12
+ #
13
+ # Params, sent as the JSON body:
14
+ # - `account_number` (String): Account numbers appear in the QuickBooks chart of accounts,
15
+ # Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false
16
+ # (that is, if the QuickBooks user has the account numbers Preference turned off), you can
17
+ # still set account numbers through the SDK, but the numbers won’t be visible in the user
18
+ # interface.
19
+ # - `account_type` (one of "AccountsPayable", "AccountsReceivable", "Bank", "CostOfGoodsSold",
20
+ # "CreditCard", "Equity", "Expense", "FixedAsset", "Income", "LongTermLiability",
21
+ # "NonPosting", "OtherAsset", "OtherCurrentAsset", "OtherCurrentLiability", "OtherExpense",
22
+ # "OtherIncome", required): The type of QuickBooks account. You can’t create or modify a
23
+ # non-posting account through the SDK, because QuickBooks creates these accounts behind the
24
+ # scenes. This means that you can’t send an AccountAdd request with an `account_type` of
25
+ # NonPosting.
26
+ # - `bank_number` (String): The bank account number or an identifying note about the account.
27
+ # If a `bank_number` exists in a QuickBooks company file, it will only be returned to
28
+ # applications that have been granted permission to access sensitive data and that are using
29
+ # SDK v2.0 or greater.
30
+ # - `currency_ref` (Hash): A currency record defines how QuickBooks stores and displays a
31
+ # currency. Built-in currency name/code values are fixed; formatting and active status can
32
+ # vary by settings and workflow.
33
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
34
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
35
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
36
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
37
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
38
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
39
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
40
+ # - `desc` (String): A descriptive text field.
41
+ # - `detail_account_type` (one of "AP", "AR", "AccumulatedAdjustment",
42
+ # "AccumulatedAmortization", "AccumulatedAmortizationOfOtherAssets", "AccumulatedDepletion",
43
+ # "AccumulatedDepreciation", "AdvertisingOrPromotional", "AllowanceForBadDebts",
44
+ # "Amortization", "Auto", "BadDebts", "BankCharges", "Buildings", "CashOnHand",
45
+ # "CharitableContributions", "Checking", "CommonStock", "CostOfLabor", "CostOfLaborCOS",
46
+ # "CreditCard", "DepletableAssets", "Depreciation", "DevelopmentCosts",
47
+ # "DiscountsOrRefundsGiven", "DividendIncome", "DuesAndSubscriptions",
48
+ # "EmployeeCashAdvances", "Entertainment", "EntertainmentMeals", "EquipmentRental",
49
+ # "EquipmentRentalCOS", "FederalIncomeTaxPayable", "FurnitureAndFixtures", "Goodwill",
50
+ # "Insurance", "InsurancePayable", "IntangibleAssets", "InterestEarned", "InterestPaid",
51
+ # "Inventory", "InvestmentMortgageOrRealEstateLoans", "InvestmentOther",
52
+ # "InvestmentTaxExemptSecurities", "InvestmentUSGovObligations", "Land", "LeaseBuyout",
53
+ # "LeaseholdImprovements", "LegalAndProfessionalFees", "Licenses", "LineOfCredit",
54
+ # "LoanPayable", "LoansToOfficers", "LoansToOthers", "LoansToStockholders",
55
+ # "MachineryAndEquipment", "MoneyMarket", "NonProfitIncome", "NotesPayable",
56
+ # "OfficeOrGeneralAdministrativeExpenses", "OpeningBalanceEquity", "OrganizationalCosts",
57
+ # "OtherCostsOfServiceCOS", "OtherCurrentAssets", "OtherCurrentLiab", "OtherFixedAssets",
58
+ # "OtherInvestmentIncome", "OtherLongTermAssets", "OtherLongTermLiab", "OtherMiscExpense",
59
+ # "OtherMiscIncome", "OtherMiscServiceCost", "OtherPrimaryIncome", "OwnersEquity",
60
+ # "PaidInCapitalOrSurplus", "PartnerContributions", "PartnerDistributions",
61
+ # "PartnersEquity", "PayrollClearing", "PayrollExpenses", "PayrollTaxPayable",
62
+ # "PenaltiesAndSettlements", "PreferredStock", "PrepaidExpenses", "PrepaidExpensesPayable",
63
+ # "PromotionalMeals", "RentOrLeaseOfBuildings", "RentsHeldInTrust", "RentsInTrustLiab",
64
+ # "RepairAndMaintenance", "Retainage", "RetainedEarnings", "SalesOfProductIncome",
65
+ # "SalesTaxPayable", "Savings", "SecurityDeposits", "ServiceOrFeeIncome",
66
+ # "ShareholderNotesPayable", "ShippingFreightAndDelivery", "ShippingFreightAndDeliveryCOS",
67
+ # "StateOrLocalIncomeTaxPayable", "SuppliesAndMaterials", "SuppliesAndMaterialsCOGS",
68
+ # "TaxExemptInterest", "TaxesPaid", "Travel", "TravelMeals", "TreasuryStock",
69
+ # "TrustAccounts", "TrustAccountsLiab", "UndepositedFunds", "Utilities", "Vehicles")
70
+ # - `include_ret_element` (Array<one of "AccountNumber", "AccountType", "Balance",
71
+ # "BankNumber", "CashFlowClassification", "CurrencyRef", "DataExtRet", "Desc",
72
+ # "DetailAccountType", "EditSequence", "ExternalGUID", "FullName", "IsActive",
73
+ # "IsTaxAccount", "LastCheckNumber", "ListID", "Name", "OwnerID", "ParentRef",
74
+ # "SalesTaxCodeRef", "SpecialAccountType", "Sublevel", "TaxLineInfoRet", "TimeCreated",
75
+ # "TimeModified", "TotalBalance", "TxnID", "TxnNumber">)
76
+ # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
77
+ # QuickBooks. The default value is true.
78
+ # - `name` (String, required): Name is the case-insensitive short name of a list object
79
+ # (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can
80
+ # reuse the same Name in different branches because `full_name` remains distinct.
81
+ # - `open_balance` (Numeric): The amount of money in, or the value of, this account as of
82
+ # `open_balance_date`. On a bank statement, the amount of money in the account at the
83
+ # beginning of the statement period.
84
+ # - `open_balance_date` (String): The date when an opening balance was entered for this
85
+ # account.
86
+ # - `parent_ref` (Hash): A reference to the list object that is one level above this one. For
87
+ # example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA
88
+ # might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request,
89
+ # if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be
90
+ # ignored.
91
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
92
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
93
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
94
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
95
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
96
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
97
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
98
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
99
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
100
+ # webhook already carries the request's `id`.
101
+ # - `sales_tax_code_ref` (Hash): `sales_tax_code_ref` points to the sales-tax code used for an
102
+ # item or customer context. QuickBooks includes default TAX and NON codes, and a code can be
103
+ # deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the
104
+ # default non-taxable code. If both `full_name` and `list_id` are provided in
105
+ # `sales_tax_code_ref`, `full_name` is ignored.
106
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
107
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
108
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
109
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
110
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
111
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
112
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
113
+ # - `tax_line_id` (Integer): An internal representation of the tax line associated with this
114
+ # account.
115
+ #
116
+ # @param connection_id [String]
117
+ # @param params [Hash] the fields above
118
+ # @param webhook_url [String] where QuBe Sync sends the answer
119
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
120
+ # @return [Hash] the queued request
121
+ # @see https://docs.qubesync.com/api-reference/v2/accounts/create-account
122
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
123
+ queue("account.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
124
+ end
125
+
126
+ # List accounts: GET /connections/{connection_id}/accounts (`account.query`).
127
+ #
128
+ # QuickBooks answers in one webhook.
129
+ #
130
+ # Params, sent as the query string:
131
+ # - `account_type` (Array<one of "AccountsPayable", "AccountsReceivable", "Bank",
132
+ # "CostOfGoodsSold", "CreditCard", "Equity", "Expense", "FixedAsset", "Income",
133
+ # "LongTermLiability", "NonPosting", "OtherAsset", "OtherCurrentAsset",
134
+ # "OtherCurrentLiability", "OtherExpense", "OtherIncome">): The type of QuickBooks account.
135
+ # You can’t create or modify a non-posting account through the SDK, because QuickBooks
136
+ # creates these accounts behind the scenes. This means that you can’t send an AccountAdd
137
+ # request with an `account_type` of NonPosting. Choose at most one of: `list_id`, or
138
+ # `full_name`, or the set (`account_type`, `active_status`, `currency_filter`,
139
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
140
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
141
+ # - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): Used in filters to select
142
+ # list objects based on whether or not they are currently enabled for use by QuickBooks. The
143
+ # default value is asActiveOnly, which selects only list objects that are active. Choose at
144
+ # most one of: `list_id`, or `full_name`, or the set (`account_type`, `active_status`,
145
+ # `currency_filter`, `from_modified_date`, `max_returned`, `name_filter`,
146
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
147
+ # with the other choices.
148
+ # - `currency_filter` (Hash): Filters by the specified currency. Choose at most one of:
149
+ # `list_id`, or `full_name`, or the set (`account_type`, `active_status`, `currency_filter`,
150
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
151
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
152
+ # Give at most one of: `list_id`, or `full_name`.
153
+ # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
154
+ # list object. The `full_name` is the name prefixed by the names of each ancestor, for
155
+ # example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
156
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
157
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
158
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
159
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
160
+ # - `from_modified_date` (String): Filters results to objects modified on or after this
161
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
162
+ # date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or
163
+ # `full_name`, or the set (`account_type`, `active_status`, `currency_filter`,
164
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
165
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
166
+ # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
167
+ # list object. The `full_name` is the name prefixed by the names of each ancestor, for
168
+ # example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. Choose at most
169
+ # one of: `list_id`, or `full_name`, or the set (`account_type`, `active_status`,
170
+ # `currency_filter`, `from_modified_date`, `max_returned`, `name_filter`,
171
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
172
+ # with the other choices.
173
+ # - `include_ret_element` (Array<one of "AccountNumber", "AccountType", "Balance",
174
+ # "BankNumber", "CashFlowClassification", "CurrencyRef", "DataExtRet", "Desc",
175
+ # "DetailAccountType", "EditSequence", "FullName", "IsActive", "IsTaxAccount",
176
+ # "LastCheckNumber", "ListID", "Name", "ParentRef", "SalesTaxCodeRef", "SpecialAccountType",
177
+ # "Sublevel", "TaxLineInfoRet", "TimeCreated", "TimeModified", "TotalBalance">)
178
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
179
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
180
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
181
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`. Choose at most
182
+ # one of: `list_id`, or `full_name`, or the set (`account_type`, `active_status`,
183
+ # `currency_filter`, `from_modified_date`, `max_returned`, `name_filter`,
184
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
185
+ # with the other choices.
186
+ # - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
187
+ # count of how many objects could possibly be returned, use the `meta_data` query
188
+ # attribute.) If you include a `max_returned` value, it must be at least 1. QuickBooks
189
+ # doesn't page this query: at most this many records come back, in one answer, with no sign
190
+ # of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the
191
+ # Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type`
192
+ # `response_too_large`), so narrow a large one with its filters. Choose at most one of:
193
+ # `list_id`, or `full_name`, or the set (`account_type`, `active_status`, `currency_filter`,
194
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
195
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
196
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
197
+ # `meta_data` attribute to control whether query responses include counts. Options are
198
+ # NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
199
+ # objects). Counts are approximate and may vary slightly if records are created or deleted
200
+ # during processing.
201
+ # - `name_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
202
+ # `list_id`, or `full_name`, or the set (`account_type`, `active_status`, `currency_filter`,
203
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
204
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
205
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
206
+ # to match.
207
+ # - `name` (String, required): The string to match.
208
+ # - `name_range_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
209
+ # `list_id`, or `full_name`, or the set (`account_type`, `active_status`, `currency_filter`,
210
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
211
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
212
+ # - `from_name` (String): The first name or item in the search range. If `from_name` is
213
+ # omitted, the range will begin with first name on the list.
214
+ # - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
215
+ # the range will end with last name on the list.
216
+ # - `owner_id` (Array<String>): `owner_id` identifies who owns the data extension. Use 0 for
217
+ # QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned
218
+ # by an app. Keep private GUIDs confidential unless you intentionally share extensions
219
+ # across apps. If you do share them, both apps must use the same `owner_id` and
220
+ # `data_ext_name`, because that pair uniquely identifies the extension.
221
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
222
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
223
+ # webhook already carries the request's `id`.
224
+ # - `to_modified_date` (String): Filters results to objects modified on or before this
225
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
226
+ # date is provided, time defaults to end-of-day (23:59:59). Choose at most one of:
227
+ # `list_id`, or `full_name`, or the set (`account_type`, `active_status`, `currency_filter`,
228
+ # `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`,
229
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
230
+ #
231
+ # @param connection_id [String]
232
+ # @param params [Hash] the fields above
233
+ # @param webhook_url [String] where QuBe Sync sends the answer
234
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
235
+ # @return [Hash] the queued request
236
+ # @see https://docs.qubesync.com/api-reference/v2/accounts/list-accounts
237
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
238
+ queue("account.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
239
+ end
240
+
241
+ # Update account: PUT /connections/{connection_id}/accounts (`account.update`).
242
+ #
243
+ # QuickBooks answers in one webhook.
244
+ #
245
+ # Params, sent as the JSON body:
246
+ # - `account_number` (String): Account numbers appear in the QuickBooks chart of accounts,
247
+ # Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false
248
+ # (that is, if the QuickBooks user has the account numbers Preference turned off), you can
249
+ # still set account numbers through the SDK, but the numbers won’t be visible in the user
250
+ # interface.
251
+ # - `account_type` (one of "AccountsPayable", "AccountsReceivable", "Bank", "CostOfGoodsSold",
252
+ # "CreditCard", "Equity", "Expense", "FixedAsset", "Income", "LongTermLiability",
253
+ # "NonPosting", "OtherAsset", "OtherCurrentAsset", "OtherCurrentLiability", "OtherExpense",
254
+ # "OtherIncome"): The type of QuickBooks account. You can’t create or modify a non-posting
255
+ # account through the SDK, because QuickBooks creates these accounts behind the scenes. This
256
+ # means that you can’t send an AccountAdd request with an `account_type` of NonPosting.
257
+ # - `bank_number` (String): The bank account number or an identifying note about the account.
258
+ # If a `bank_number` exists in a QuickBooks company file, it will only be returned to
259
+ # applications that have been granted permission to access sensitive data and that are using
260
+ # SDK v2.0 or greater.
261
+ # - `currency_ref` (Hash): A currency record defines how QuickBooks stores and displays a
262
+ # currency. Built-in currency name/code values are fixed; formatting and active status can
263
+ # vary by settings and workflow.
264
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
265
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
266
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
267
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
268
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
269
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
270
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
271
+ # - `desc` (String): A descriptive text field.
272
+ # - `edit_sequence` (String, required): `edit_sequence` is a server-generated revision token.
273
+ # It changes each time the object is updated. To modify an existing object, you must send
274
+ # the current `edit_sequence`. If your value is stale, the update is rejected to prevent
275
+ # overwriting newer changes.
276
+ # - `include_ret_element` (Array<one of "AccountNumber", "AccountType", "Balance",
277
+ # "BankNumber", "CashFlowClassification", "CurrencyRef", "DataExtRet", "Desc",
278
+ # "DetailAccountType", "EditSequence", "ExternalGUID", "FullName", "IsActive",
279
+ # "IsTaxAccount", "LastCheckNumber", "ListID", "Name", "OwnerID", "ParentRef",
280
+ # "SalesTaxCodeRef", "SpecialAccountType", "Sublevel", "TaxLineInfoRet", "TimeCreated",
281
+ # "TimeModified", "TotalBalance", "TxnID", "TxnNumber">)
282
+ # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
283
+ # QuickBooks. The default value is true.
284
+ # - `list_id` (String, required): `list_id` and `full_name` both identify a list object.
285
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
286
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
287
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
288
+ # - `name` (String): Name is the case-insensitive short name of a list object (without
289
+ # ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the
290
+ # same Name in different branches because `full_name` remains distinct.
291
+ # - `open_balance` (Numeric): The amount of money in, or the value of, this account as of
292
+ # `open_balance_date`. On a bank statement, the amount of money in the account at the
293
+ # beginning of the statement period.
294
+ # - `open_balance_date` (String): The date when an opening balance was entered for this
295
+ # account.
296
+ # - `parent_ref` (Hash): A reference to the list object that is one level above this one. For
297
+ # example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA
298
+ # might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request,
299
+ # if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be
300
+ # ignored.
301
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
302
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
303
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
304
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
305
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
306
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
307
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
308
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
309
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
310
+ # webhook already carries the request's `id`.
311
+ # - `sales_tax_code_ref` (Hash): `sales_tax_code_ref` points to the sales-tax code used for an
312
+ # item or customer context. QuickBooks includes default TAX and NON codes, and a code can be
313
+ # deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the
314
+ # default non-taxable code. If both `full_name` and `list_id` are provided in
315
+ # `sales_tax_code_ref`, `full_name` is ignored.
316
+ # - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
317
+ # object. The `full_name` is the name prefixed by the names of each ancestor, for example
318
+ # Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
319
+ # - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
320
+ # assigns `list_id` when the object is created. `list_id` values are unique within a list
321
+ # type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
322
+ # request, QuickBooks uses `list_id` and ignores `full_name`.
323
+ # - `tax_line_id` (Integer): An internal representation of the tax line associated with this
324
+ # account.
325
+ #
326
+ # @param connection_id [String]
327
+ # @param params [Hash] the fields above
328
+ # @param webhook_url [String] where QuBe Sync sends the answer
329
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
330
+ # @return [Hash] the queued request
331
+ # @see https://docs.qubesync.com/api-reference/v2/accounts/update-account
332
+ def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
333
+ queue("account.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
334
+ end
335
+ end
336
+ end
337
+ end
@@ -0,0 +1,30 @@
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 account tax line info operations, reached as `client.account_tax_line_info`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class AccountTaxLineInfo < Base
9
+ # List account tax line infos: GET /connections/{connection_id}/account-tax-line-infos
10
+ # (`account_tax_line_info.query`).
11
+ #
12
+ # QuickBooks answers in one webhook.
13
+ #
14
+ # Params, sent as the query string:
15
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
16
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
17
+ # webhook already carries the request's `id`.
18
+ #
19
+ # @param connection_id [String]
20
+ # @param params [Hash] the fields above
21
+ # @param webhook_url [String] where QuBe Sync sends the answer
22
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
23
+ # @return [Hash] the queued request
24
+ # @see https://docs.qubesync.com/api-reference/v2/account-tax-line-infos/list-account-tax-line-infos
25
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
26
+ queue("account_tax_line_info.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,160 @@
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 aging report operations, reached as `client.aging_report`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class AgingReport < Base
9
+ # List aging reports: GET /connections/{connection_id}/aging-reports (`aging_report.query`).
10
+ #
11
+ # QuickBooks answers in one webhook.
12
+ #
13
+ # Params, sent as the query string:
14
+ # - `aging_report_type` (one of "APAgingDetail", "APAgingSummary", "ARAgingDetail",
15
+ # "ARAgingSummary", "CollectionsReport", required): The type of aging report being queried.
16
+ # - `display_report` (Boolean): Set `display_report` to true to display this report within the
17
+ # QuickBooks UI. (Default is false.) If you want the request to display the report without
18
+ # returning any data to your application, set the responseData attribute to includeNone.
19
+ # - `include_accounts` (one of "All", "InUse"): Indicates whether this report should include
20
+ # all accounts or just those that are currently in use.
21
+ # - `include_column` (Array<one of "Account", "Aging", "Amount", "AmountDifference",
22
+ # "AverageCost", "BilledDate", "BillingStatus", "CalculatedAmount", "Class",
23
+ # "ClearedStatus", "CostPrice", "Credit", "Currency", "Date", "Debit", "DeliveryDate",
24
+ # "DueDate", "EstimateActive", "ExchangeRate", "FOB", "IncomeSubjectToTax", "Invoiced",
25
+ # "Item", "ItemDesc", "LastModifiedBy", "LatestOrPriorState", "Memo", "ModifiedTime",
26
+ # "Name", "NameAccountNumber", "NameAddress", "NameCity", "NameContact", "NameEmail",
27
+ # "NameFax", "NamePhone", "NameState", "NameZip", "OpenBalance", "OriginalAmount",
28
+ # "PONumber", "PaidAmount", "PaidStatus", "PaidThroughDate", "PaymentMethod", "PayrollItem",
29
+ # "PrintStatus", "ProgressAmount", "ProgressPercent", "Quantity", "QuantityAvailable",
30
+ # "QuantityOnHand", "QuantityOnSalesOrder", "ReceivedQuantity", "RefNumber",
31
+ # "RunningBalance", "SSNOrTaxID", "SalesRep", "SalesTaxCode", "SerialOrLotNumber",
32
+ # "ShipDate", "ShipMethod", "SourceName", "SplitAccount", "TaxLine", "TaxTableVersion",
33
+ # "Terms", "TxnID", "TxnNumber", "TxnType", "UnitPrice", "UserEdit", "ValueOnHand",
34
+ # "WageBase", "WageBaseTips">)
35
+ # - `report_account_filter` (Hash): Allows you to query for a specified account type or for
36
+ # specific list elements.
37
+ # Give at most one of: `account_type_filter`, or `list_id`, or `full_name`, or
38
+ # `list_id_with_children`, or `full_name_with_children`.
39
+ # - `account_type_filter` (one of "APAndSalesTax", "APOrCreditCard", "ARAndAP",
40
+ # "AccountsPayable", "AccountsReceivable", "AllowedFor1099", "Asset", "BalanceSheet",
41
+ # "Bank", "BankAndARAndAPAndUF", "BankAndUF", "CostOfSales", "CreditCard", "CurrentAsset",
42
+ # "CurrentAssetAndExpense", "CurrentLiability", "Equity", "EquityAndIncomeAndExpense",
43
+ # "ExpenseAndOtherExpense", "FixedAsset", "IncomeAndExpense", "IncomeAndOtherIncome",
44
+ # "Liability", "LiabilityAndEquity", "LongTermLiability", "NonPosting", "OrdinaryExpense",
45
+ # "OrdinaryIncome", "OrdinaryIncomeAndCOGS", "OrdinaryIncomeAndExpense", "OtherAsset",
46
+ # "OtherCurrentAsset", "OtherCurrentLiability", "OtherExpense", "OtherIncome",
47
+ # "OtherIncomeOrExpense"): Allows you to report on a specific account type.
48
+ # - `full_name` (Array<String>)
49
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
50
+ # specified object and its descendants. For names that don’t have children,
51
+ # `full_name_with_children` is exactly the same as `full_name`.
52
+ # - `list_id` (Array<String>)
53
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
54
+ # specified object and its descendants.
55
+ # - `report_aging_as_of` (one of "ReportEndDate", "Today"): The report will return aging
56
+ # information up to the `report_aging_as_of` date.
57
+ # - `report_class_filter` (Hash): Allows you to query for a specified class. Classes can be
58
+ # used to separate transactions into meaningful categories. (For example, transactions could
59
+ # be classified according to department, business location, or type of work.) In QuickBooks,
60
+ # class tracking is off by default.
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): Allows you to filter for data that relates to the
65
+ # specified object and its descendants. For names that don’t have children,
66
+ # `full_name_with_children` is exactly the same as `full_name`.
67
+ # - `list_id` (Array<String>)
68
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
69
+ # specified object and its descendants.
70
+ # - `report_date_macro` (one of "All", "LastMonth", "LastMonthToDate", "LastQuarter",
71
+ # "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear", "LastYearToDate",
72
+ # "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear", "ThisMonth",
73
+ # "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek", "ThisWeekToDate",
74
+ # "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period covered by this
75
+ # report. Choose at most one of: `report_period`, or `report_date_macro`.
76
+ # - `report_detail_level_filter` (one of "All", "AllExceptSummary", "SummaryOnly"): The level
77
+ # of detail to include in the report.
78
+ # - `report_entity_filter` (Hash): Allows you to query for a specified name type (customer,
79
+ # employee, vendor, or other) or query for specific list elements.
80
+ # Give at most one of: `entity_type_filter`, or `list_id`, or `full_name`, or
81
+ # `list_id_with_children`, or `full_name_with_children`.
82
+ # - `entity_type_filter` (one of "Customer", "Employee", "OtherName", "Vendor"): Allows you
83
+ # to report on a specific name type.
84
+ # - `full_name` (Array<String>)
85
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
86
+ # specified object and its descendants. For names that don’t have children,
87
+ # `full_name_with_children` is exactly the same as `full_name`.
88
+ # - `list_id` (Array<String>)
89
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
90
+ # specified object and its descendants.
91
+ # - `report_item_filter` (Hash): Allows you to query for a specified item type (for example,
92
+ # discount, inventory, or non-inventory) or query for specific list elements.
93
+ # Give at most one of: `item_type_filter`, or `list_id`, or `full_name`, or
94
+ # `list_id_with_children`, or `full_name_with_children`.
95
+ # - `full_name` (Array<String>)
96
+ # - `full_name_with_children` (String): Allows you to filter for data that relates to the
97
+ # specified object and its descendants. For names that don’t have children,
98
+ # `full_name_with_children` is exactly the same as `full_name`.
99
+ # - `item_type_filter` (one of "AllExceptFixedAsset", "Assembly", "Discount", "FixedAsset",
100
+ # "Inventory", "InventoryAndAssembly", "NonInventory", "OtherCharge", "Payment", "Sales",
101
+ # "SalesTax", "Service"): Allows you to report on a specific item type.
102
+ # - `list_id` (Array<String>)
103
+ # - `list_id_with_children` (String): Allows you to filter for data that relates to the
104
+ # specified object and its descendants.
105
+ # - `report_modified_date_range_filter` (Hash): Returns reports that were modified between
106
+ # these two dates (inclusive). The range of acceptable dates for both
107
+ # `from_report_modified_date` and `to_report_modified_date` is 1970-01-01 to
108
+ # 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). Choose at most one of:
109
+ # `report_modified_date_range_filter`, or `report_modified_date_range_macro`.
110
+ # - `from_report_modified_date` (String): Selects information from this date and later. The
111
+ # range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
112
+ # (2038-01-18T19:14:07-08:00 PST).
113
+ # - `to_report_modified_date` (String): Selects information created on this date or earlier.
114
+ # The range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07
115
+ # (2038-01-18T19:14:07-08:00 PST).
116
+ # - `report_modified_date_range_macro` (one of "All", "LastMonth", "LastMonthToDate",
117
+ # "LastQuarter", "LastQuarterToDate", "LastWeek", "LastWeekToDate", "LastYear",
118
+ # "LastYearToDate", "NextFourWeeks", "NextMonth", "NextQuarter", "NextWeek", "NextYear",
119
+ # "ThisMonth", "ThisMonthToDate", "ThisQuarter", "ThisQuarterToDate", "ThisWeek",
120
+ # "ThisWeekToDate", "ThisYear", "ThisYearToDate", "Today", "Yesterday"): The time period
121
+ # covered by this report. Choose at most one of: `report_modified_date_range_filter`, or
122
+ # `report_modified_date_range_macro`.
123
+ # - `report_period` (Hash): If you omit both `to_report_date` and `from_report_date`, the
124
+ # report will cover the current fiscal year to date. Choose at most one of: `report_period`,
125
+ # or `report_date_macro`.
126
+ # - `from_report_date` (String): Selects information from this date and later. The range of
127
+ # acceptable `from_report_date` and `to_report_date` values depends on how the report
128
+ # dates are determined. If the report dates are based on the dates of transactions, the
129
+ # range is 01/01/1901 to 12/31/9999.
130
+ # - `to_report_date` (String): Selects information created on this date or earlier. The
131
+ # range of acceptable `to_report_date` and `from_report_date` values depends on how the
132
+ # report dates are determined. If the report dates are based on the dates of transactions,
133
+ # the range is 01/01/1901 to 12/31/9999.
134
+ # - `report_posting_status_filter` (one of "Either", "NonPosting", "Posting"): Allows you to
135
+ # query for posting reports, non-posting reports, or reports that are either one.
136
+ # - `report_txn_type_filter` (Hash): Allows you to report on specific transaction types (for
137
+ # example, charge, check, deposit, or estimate).
138
+ # - `txn_type_filter` (Array<one of "ARRefundCreditCard", "All", "Bill", "BillPaymentCheck",
139
+ # "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check", "CreditCardCharge",
140
+ # "CreditCardCredit", "CreditMemo", "Deposit", "Estimate", "InventoryAdjustment",
141
+ # "Invoice", "ItemReceipt", "JournalEntry", "LiabilityAdjustment", "Paycheck",
142
+ # "PayrollLiabilityCheck", "PurchaseOrder", "ReceivePayment", "SalesOrder",
143
+ # "SalesReceipt", "SalesTaxPaymentCheck", "Transfer", "VendorCredit", "YTDAdjustment">,
144
+ # required)
145
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
146
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
147
+ # webhook already carries the request's `id`.
148
+ #
149
+ # @param connection_id [String]
150
+ # @param params [Hash] the fields above
151
+ # @param webhook_url [String] where QuBe Sync sends the answer
152
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
153
+ # @return [Hash] the queued request
154
+ # @see https://docs.qubesync.com/api-reference/v2/aging-reports/list-aging-reports
155
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
156
+ queue("aging_report.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
157
+ end
158
+ end
159
+ end
160
+ end
@@ -0,0 +1,91 @@
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 alert operations, reached as `client.alert`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class Alert < Base
9
+ # Create alert: POST /connections/{connection_id}/alerts (`alert.create`).
10
+ #
11
+ # QuickBooks answers in one webhook.
12
+ #
13
+ # Params, sent as the JSON body:
14
+ # Give at most one of: `com_callback_info`, or `http_callback_info`.
15
+ # - `activation_date` (String)
16
+ # - `alert_permission` (Hash)
17
+ # - `permission_level` (Array<one of "AccountsPayable", "AccountsReceivable", "Banking",
18
+ # "Finance", "Inventory", "TimeTracking">, required)
19
+ # - `permission_needed` (one of "All", "Any", required)
20
+ # - `alert_tag` (String, required)
21
+ # - `com_callback_info` (Hash)
22
+ # Give at most one of: `prog_id`, or `clsid`.
23
+ # - `app_name` (String, required)
24
+ # - `clsid` (String)
25
+ # - `prog_id` (String)
26
+ # - `desc` (String, required)
27
+ # - `expiration_date` (String)
28
+ # - `help_text` (String, required)
29
+ # - `http_callback_info` (Hash)
30
+ # - `url` (String, required)
31
+ # - `message_text` (String, required)
32
+ # - `owner_id` (String, required)
33
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
34
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
35
+ # webhook already carries the request's `id`.
36
+ # - `ui_context` (Array<one of "AlertsManager", "CompanyNavigator">)
37
+ #
38
+ # @param connection_id [String]
39
+ # @param params [Hash] the fields above
40
+ # @param webhook_url [String] where QuBe Sync sends the answer
41
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
42
+ # @return [Hash] the queued request
43
+ # @see https://docs.qubesync.com/api-reference/v2/alerts/create-alert
44
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
45
+ queue("alert.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
46
+ end
47
+
48
+ # Delete alert: DELETE /connections/{connection_id}/alerts (`alert.delete`).
49
+ #
50
+ # QuickBooks answers in one webhook.
51
+ #
52
+ # Params, sent as the JSON body:
53
+ # - `alert_tag` (String, required)
54
+ # - `owner_id` (String, required)
55
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
56
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
57
+ # webhook already carries the request's `id`.
58
+ #
59
+ # @param connection_id [String]
60
+ # @param params [Hash] the fields above
61
+ # @param webhook_url [String] where QuBe Sync sends the answer
62
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
63
+ # @return [Hash] the queued request
64
+ # @see https://docs.qubesync.com/api-reference/v2/alerts/delete-alert
65
+ def delete(connection_id, params = {}, webhook_url:, idempotency_key: nil)
66
+ queue("alert.delete", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
67
+ end
68
+
69
+ # List alerts: GET /connections/{connection_id}/alerts (`alert.query`).
70
+ #
71
+ # QuickBooks answers in one webhook.
72
+ #
73
+ # Params, sent as the query string:
74
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData")
75
+ # - `owner_id` (Array<String>, required)
76
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
77
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
78
+ # webhook already carries the request's `id`.
79
+ #
80
+ # @param connection_id [String]
81
+ # @param params [Hash] the fields above
82
+ # @param webhook_url [String] where QuBe Sync sends the answer
83
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
84
+ # @return [Hash] the queued request
85
+ # @see https://docs.qubesync.com/api-reference/v2/alerts/list-alerts
86
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
87
+ queue("alert.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
88
+ end
89
+ end
90
+ end
91
+ end