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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +48 -0
- data/README.md +235 -75
- data/Rakefile +12 -0
- data/lib/qube_sync/client.rb +579 -0
- data/lib/qube_sync/operations/account.rb +337 -0
- data/lib/qube_sync/operations/account_tax_line_info.rb +30 -0
- data/lib/qube_sync/operations/aging_report.rb +160 -0
- data/lib/qube_sync/operations/alert.rb +91 -0
- data/lib/qube_sync/operations/ar_refund_credit_card.rb +399 -0
- data/lib/qube_sync/operations/bar_code.rb +37 -0
- data/lib/qube_sync/operations/bill.rb +1073 -0
- data/lib/qube_sync/operations/bill_payment_check.rb +413 -0
- data/lib/qube_sync/operations/bill_payment_credit_card.rb +315 -0
- data/lib/qube_sync/operations/bill_to_pay.rb +66 -0
- data/lib/qube_sync/operations/billing_rate.rb +172 -0
- data/lib/qube_sync/operations/budget_summary_report.rb +80 -0
- data/lib/qube_sync/operations/build_assembly.rb +318 -0
- data/lib/qube_sync/operations/charge.rb +452 -0
- data/lib/qube_sync/operations/check.rb +1055 -0
- data/lib/qube_sync/operations/class.rb +176 -0
- data/lib/qube_sync/operations/cleared_status.rb +39 -0
- data/lib/qube_sync/operations/company.rb +39 -0
- data/lib/qube_sync/operations/company_activity.rb +31 -0
- data/lib/qube_sync/operations/credit_card_charge.rb +1000 -0
- data/lib/qube_sync/operations/credit_card_credit.rb +1000 -0
- data/lib/qube_sync/operations/credit_memo.rb +1243 -0
- data/lib/qube_sync/operations/currency.rb +195 -0
- data/lib/qube_sync/operations/custom_detail_report.rb +176 -0
- data/lib/qube_sync/operations/custom_summary_report.rb +180 -0
- data/lib/qube_sync/operations/customer.rb +744 -0
- data/lib/qube_sync/operations/customer_msg.rb +117 -0
- data/lib/qube_sync/operations/customer_type.rb +133 -0
- data/lib/qube_sync/operations/data_event_recovery_info.rb +54 -0
- data/lib/qube_sync/operations/data_ext.rb +201 -0
- data/lib/qube_sync/operations/data_ext_def.rb +179 -0
- data/lib/qube_sync/operations/date_driven_terms.rb +131 -0
- data/lib/qube_sync/operations/deposit.rb +555 -0
- data/lib/qube_sync/operations/employee.rb +577 -0
- data/lib/qube_sync/operations/employee_default.rb +100 -0
- data/lib/qube_sync/operations/entity.rb +118 -0
- data/lib/qube_sync/operations/estimate.rb +1055 -0
- data/lib/qube_sync/operations/form1099_category_account_mapping.rb +90 -0
- data/lib/qube_sync/operations/general_detail_report.rb +185 -0
- data/lib/qube_sync/operations/general_summary_report.rb +180 -0
- data/lib/qube_sync/operations/host.rb +36 -0
- data/lib/qube_sync/operations/inventory_adjustment.rb +482 -0
- data/lib/qube_sync/operations/inventory_site.rb +214 -0
- data/lib/qube_sync/operations/invoice.rb +1208 -0
- data/lib/qube_sync/operations/item.rb +115 -0
- data/lib/qube_sync/operations/item_assemblies_can_build.rb +44 -0
- data/lib/qube_sync/operations/item_discount.rb +319 -0
- data/lib/qube_sync/operations/item_fixed_asset.rb +317 -0
- data/lib/qube_sync/operations/item_group.rb +253 -0
- data/lib/qube_sync/operations/item_inventory.rb +446 -0
- data/lib/qube_sync/operations/item_inventory_assembly.rb +483 -0
- data/lib/qube_sync/operations/item_non_inventory.rb +461 -0
- data/lib/qube_sync/operations/item_other_charge.rb +434 -0
- data/lib/qube_sync/operations/item_payment.rb +268 -0
- data/lib/qube_sync/operations/item_receipt.rb +1011 -0
- data/lib/qube_sync/operations/item_sales_tax.rb +270 -0
- data/lib/qube_sync/operations/item_sales_tax_group.rb +200 -0
- data/lib/qube_sync/operations/item_service.rb +455 -0
- data/lib/qube_sync/operations/item_sites.rb +96 -0
- data/lib/qube_sync/operations/item_subtotal.rb +182 -0
- data/lib/qube_sync/operations/job_report.rb +156 -0
- data/lib/qube_sync/operations/job_type.rb +131 -0
- data/lib/qube_sync/operations/journal_entry.rb +518 -0
- data/lib/qube_sync/operations/lead.rb +216 -0
- data/lib/qube_sync/operations/list.rb +42 -0
- data/lib/qube_sync/operations/list_deleted.rb +57 -0
- data/lib/qube_sync/operations/list_display.rb +59 -0
- data/lib/qube_sync/operations/list_merge.rb +55 -0
- data/lib/qube_sync/operations/other_name.rb +245 -0
- data/lib/qube_sync/operations/paycheck.rb +139 -0
- data/lib/qube_sync/operations/payment_method.rb +128 -0
- data/lib/qube_sync/operations/payroll_detail_report.rb +161 -0
- data/lib/qube_sync/operations/payroll_item.rb +75 -0
- data/lib/qube_sync/operations/payroll_item_addition.rb +98 -0
- data/lib/qube_sync/operations/payroll_item_company_contribution.rb +134 -0
- data/lib/qube_sync/operations/payroll_item_deduction.rb +124 -0
- data/lib/qube_sync/operations/payroll_item_direct_deposit.rb +70 -0
- data/lib/qube_sync/operations/payroll_item_non_wage.rb +93 -0
- data/lib/qube_sync/operations/payroll_item_tax.rb +123 -0
- data/lib/qube_sync/operations/payroll_item_wage.rb +168 -0
- data/lib/qube_sync/operations/payroll_item_workers_compensation.rb +108 -0
- data/lib/qube_sync/operations/payroll_last_period.rb +30 -0
- data/lib/qube_sync/operations/payroll_liability_adjustment.rb +204 -0
- data/lib/qube_sync/operations/payroll_liability_check.rb +137 -0
- data/lib/qube_sync/operations/payroll_prior_payment.rb +178 -0
- data/lib/qube_sync/operations/payroll_summary_report.rb +157 -0
- data/lib/qube_sync/operations/payroll_year_to_date_adjustment.rb +211 -0
- data/lib/qube_sync/operations/preferences.rb +61 -0
- data/lib/qube_sync/operations/price_level.rb +305 -0
- data/lib/qube_sync/operations/purchase_order.rb +1038 -0
- data/lib/qube_sync/operations/qb_command_exec.rb +37 -0
- data/lib/qube_sync/operations/receive_payment.rb +627 -0
- data/lib/qube_sync/operations/receive_payment_to_deposit.rb +38 -0
- data/lib/qube_sync/operations/sales_order.rb +1045 -0
- data/lib/qube_sync/operations/sales_receipt.rb +1337 -0
- data/lib/qube_sync/operations/sales_rep.rb +172 -0
- data/lib/qube_sync/operations/sales_tax_code.rb +205 -0
- data/lib/qube_sync/operations/sales_tax_payable.rb +37 -0
- data/lib/qube_sync/operations/sales_tax_payment_check.rb +375 -0
- data/lib/qube_sync/operations/sales_tax_return.rb +35 -0
- data/lib/qube_sync/operations/sales_tax_return_line.rb +43 -0
- data/lib/qube_sync/operations/ship_method.rb +116 -0
- data/lib/qube_sync/operations/special_account.rb +55 -0
- data/lib/qube_sync/operations/special_item.rb +44 -0
- data/lib/qube_sync/operations/standard_terms.rb +125 -0
- data/lib/qube_sync/operations/template.rb +36 -0
- data/lib/qube_sync/operations/terms.rb +91 -0
- data/lib/qube_sync/operations/time_report.rb +127 -0
- data/lib/qube_sync/operations/time_tracking.rb +303 -0
- data/lib/qube_sync/operations/to_do.rb +260 -0
- data/lib/qube_sync/operations/transaction.rb +356 -0
- data/lib/qube_sync/operations/transfer.rb +213 -0
- data/lib/qube_sync/operations/transfer_inventory.rb +384 -0
- data/lib/qube_sync/operations/txn.rb +38 -0
- data/lib/qube_sync/operations/txn_deleted.rb +54 -0
- data/lib/qube_sync/operations/txn_display.rb +76 -0
- data/lib/qube_sync/operations/txn_void.rb +36 -0
- data/lib/qube_sync/operations/unit_of_measure_set.rb +149 -0
- data/lib/qube_sync/operations/vehicle.rb +152 -0
- data/lib/qube_sync/operations/vehicle_mileage.rb +191 -0
- data/lib/qube_sync/operations/vendor.rb +661 -0
- data/lib/qube_sync/operations/vendor_credit.rb +1008 -0
- data/lib/qube_sync/operations/vendor_type.rb +131 -0
- data/lib/qube_sync/operations/workers_comp_code.rb +184 -0
- data/lib/qube_sync/operations.rb +1165 -0
- data/lib/qube_sync/version.rb +1 -1
- data/lib/qube_sync.rb +1 -0
- data/sig/qube_sync/client.rbs +82 -0
- data/sig/qube_sync/operations/account.rbs +65 -0
- data/sig/qube_sync/operations/account_tax_line_info.rbs +13 -0
- data/sig/qube_sync/operations/aging_report.rbs +29 -0
- data/sig/qube_sync/operations/alert.rbs +53 -0
- data/sig/qube_sync/operations/ar_refund_credit_card.rbs +53 -0
- data/sig/qube_sync/operations/bar_code.rbs +16 -0
- data/sig/qube_sync/operations/bill.rbs +78 -0
- data/sig/qube_sync/operations/bill_payment_check.rbs +62 -0
- data/sig/qube_sync/operations/bill_payment_credit_card.rbs +45 -0
- data/sig/qube_sync/operations/bill_to_pay.rbs +19 -0
- data/sig/qube_sync/operations/billing_rate.rbs +40 -0
- data/sig/qube_sync/operations/budget_summary_report.rbs +22 -0
- data/sig/qube_sync/operations/build_assembly.rbs +64 -0
- data/sig/qube_sync/operations/charge.rbs +80 -0
- data/sig/qube_sync/operations/check.rbs +81 -0
- data/sig/qube_sync/operations/class.rbs +43 -0
- data/sig/qube_sync/operations/cleared_status.rbs +16 -0
- data/sig/qube_sync/operations/company.rbs +15 -0
- data/sig/qube_sync/operations/company_activity.rbs +14 -0
- data/sig/qube_sync/operations/credit_card_charge.rbs +69 -0
- data/sig/qube_sync/operations/credit_card_credit.rbs +69 -0
- data/sig/qube_sync/operations/credit_memo.rbs +162 -0
- data/sig/qube_sync/operations/currency.rbs +52 -0
- data/sig/qube_sync/operations/custom_detail_report.rbs +31 -0
- data/sig/qube_sync/operations/custom_summary_report.rbs +33 -0
- data/sig/qube_sync/operations/customer.rbs +174 -0
- data/sig/qube_sync/operations/customer_msg.rbs +31 -0
- data/sig/qube_sync/operations/customer_type.rbs +32 -0
- data/sig/qube_sync/operations/data_event_recovery_info.rbs +20 -0
- data/sig/qube_sync/operations/data_ext.rbs +53 -0
- data/sig/qube_sync/operations/data_ext_def.rbs +51 -0
- data/sig/qube_sync/operations/date_driven_terms.rbs +35 -0
- data/sig/qube_sync/operations/deposit.rbs +100 -0
- data/sig/qube_sync/operations/employee.rbs +173 -0
- data/sig/qube_sync/operations/employee_default.rbs +68 -0
- data/sig/qube_sync/operations/entity.rbs +24 -0
- data/sig/qube_sync/operations/estimate.rbs +148 -0
- data/sig/qube_sync/operations/form1099_category_account_mapping.rbs +33 -0
- data/sig/qube_sync/operations/general_detail_report.rbs +31 -0
- data/sig/qube_sync/operations/general_summary_report.rbs +32 -0
- data/sig/qube_sync/operations/host.rbs +19 -0
- data/sig/qube_sync/operations/inventory_adjustment.rbs +105 -0
- data/sig/qube_sync/operations/inventory_site.rbs +66 -0
- data/sig/qube_sync/operations/invoice.rbs +144 -0
- data/sig/qube_sync/operations/item.rbs +25 -0
- data/sig/qube_sync/operations/item_assemblies_can_build.rbs +15 -0
- data/sig/qube_sync/operations/item_discount.rbs +62 -0
- data/sig/qube_sync/operations/item_fixed_asset.rbs +97 -0
- data/sig/qube_sync/operations/item_group.rbs +62 -0
- data/sig/qube_sync/operations/item_inventory.rbs +87 -0
- data/sig/qube_sync/operations/item_inventory_assembly.rbs +94 -0
- data/sig/qube_sync/operations/item_non_inventory.rbs +64 -0
- data/sig/qube_sync/operations/item_other_charge.rbs +59 -0
- data/sig/qube_sync/operations/item_payment.rbs +55 -0
- data/sig/qube_sync/operations/item_receipt.rbs +71 -0
- data/sig/qube_sync/operations/item_sales_tax.rbs +57 -0
- data/sig/qube_sync/operations/item_sales_tax_group.rbs +50 -0
- data/sig/qube_sync/operations/item_service.rbs +62 -0
- data/sig/qube_sync/operations/item_sites.rbs +26 -0
- data/sig/qube_sync/operations/item_subtotal.rbs +48 -0
- data/sig/qube_sync/operations/job_report.rbs +28 -0
- data/sig/qube_sync/operations/job_type.rbs +32 -0
- data/sig/qube_sync/operations/journal_entry.rbs +88 -0
- data/sig/qube_sync/operations/lead.rbs +91 -0
- data/sig/qube_sync/operations/list.rbs +15 -0
- data/sig/qube_sync/operations/list_deleted.rbs +17 -0
- data/sig/qube_sync/operations/list_display.rbs +21 -0
- data/sig/qube_sync/operations/list_merge.rbs +22 -0
- data/sig/qube_sync/operations/other_name.rbs +71 -0
- data/sig/qube_sync/operations/paycheck.rbs +27 -0
- data/sig/qube_sync/operations/payment_method.rbs +33 -0
- data/sig/qube_sync/operations/payroll_detail_report.rbs +29 -0
- data/sig/qube_sync/operations/payroll_item.rbs +23 -0
- data/sig/qube_sync/operations/payroll_item_addition.rbs +48 -0
- data/sig/qube_sync/operations/payroll_item_company_contribution.rbs +58 -0
- data/sig/qube_sync/operations/payroll_item_deduction.rbs +54 -0
- data/sig/qube_sync/operations/payroll_item_direct_deposit.rbs +30 -0
- data/sig/qube_sync/operations/payroll_item_non_wage.rbs +23 -0
- data/sig/qube_sync/operations/payroll_item_tax.rbs +58 -0
- data/sig/qube_sync/operations/payroll_item_wage.rbs +48 -0
- data/sig/qube_sync/operations/payroll_item_workers_compensation.rbs +42 -0
- data/sig/qube_sync/operations/payroll_last_period.rbs +13 -0
- data/sig/qube_sync/operations/payroll_liability_adjustment.rbs +59 -0
- data/sig/qube_sync/operations/payroll_liability_check.rbs +27 -0
- data/sig/qube_sync/operations/payroll_prior_payment.rbs +48 -0
- data/sig/qube_sync/operations/payroll_summary_report.rbs +30 -0
- data/sig/qube_sync/operations/payroll_year_to_date_adjustment.rbs +66 -0
- data/sig/qube_sync/operations/preferences.rbs +26 -0
- data/sig/qube_sync/operations/price_level.rbs +57 -0
- data/sig/qube_sync/operations/purchase_order.rbs +159 -0
- data/sig/qube_sync/operations/qb_command_exec.rbs +22 -0
- data/sig/qube_sync/operations/receive_payment.rbs +102 -0
- data/sig/qube_sync/operations/receive_payment_to_deposit.rbs +15 -0
- data/sig/qube_sync/operations/sales_order.rbs +153 -0
- data/sig/qube_sync/operations/sales_receipt.rbs +139 -0
- data/sig/qube_sync/operations/sales_rep.rbs +43 -0
- data/sig/qube_sync/operations/sales_tax_code.rbs +49 -0
- data/sig/qube_sync/operations/sales_tax_payable.rbs +16 -0
- data/sig/qube_sync/operations/sales_tax_payment_check.rbs +64 -0
- data/sig/qube_sync/operations/sales_tax_return.rbs +14 -0
- data/sig/qube_sync/operations/sales_tax_return_line.rbs +15 -0
- data/sig/qube_sync/operations/ship_method.rbs +31 -0
- data/sig/qube_sync/operations/special_account.rbs +16 -0
- data/sig/qube_sync/operations/special_item.rbs +17 -0
- data/sig/qube_sync/operations/standard_terms.rbs +34 -0
- data/sig/qube_sync/operations/template.rbs +15 -0
- data/sig/qube_sync/operations/terms.rbs +23 -0
- data/sig/qube_sync/operations/time_report.rbs +26 -0
- data/sig/qube_sync/operations/time_tracking.rbs +57 -0
- data/sig/qube_sync/operations/to_do.rbs +59 -0
- data/sig/qube_sync/operations/transaction.rbs +39 -0
- data/sig/qube_sync/operations/transfer.rbs +47 -0
- data/sig/qube_sync/operations/transfer_inventory.rbs +76 -0
- data/sig/qube_sync/operations/txn.rbs +15 -0
- data/sig/qube_sync/operations/txn_deleted.rbs +17 -0
- data/sig/qube_sync/operations/txn_display.rbs +22 -0
- data/sig/qube_sync/operations/txn_void.rbs +15 -0
- data/sig/qube_sync/operations/types.rbs +434 -0
- data/sig/qube_sync/operations/unit_of_measure_set.rbs +51 -0
- data/sig/qube_sync/operations/vehicle.rbs +43 -0
- data/sig/qube_sync/operations/vehicle_mileage.rbs +38 -0
- data/sig/qube_sync/operations/vendor.rbs +142 -0
- data/sig/qube_sync/operations/vendor_credit.rbs +70 -0
- data/sig/qube_sync/operations/vendor_type.rbs +32 -0
- data/sig/qube_sync/operations/workers_comp_code.rbs +52 -0
- data/sig/qube_sync/operations.rbs +147 -0
- metadata +255 -2
|
@@ -0,0 +1,172 @@
|
|
|
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 sales rep operations, reached as `client.sales_rep`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class SalesRep < Base
|
|
9
|
+
# Create sales rep: POST /connections/{connection_id}/sales-reps (`sales_rep.create`).
|
|
10
|
+
#
|
|
11
|
+
# QuickBooks answers in one webhook.
|
|
12
|
+
#
|
|
13
|
+
# Params, sent as the JSON body:
|
|
14
|
+
# - `include_ret_element` (Array<one of "EditSequence", "ExternalGUID", "Initial", "IsActive",
|
|
15
|
+
# "ListID", "OwnerID", "SalesRepEntityRef", "TimeCreated", "TimeModified", "TxnID",
|
|
16
|
+
# "TxnNumber">)
|
|
17
|
+
# - `initial` (String, required): The initials of a sales representative’s name.
|
|
18
|
+
# - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
|
|
19
|
+
# QuickBooks. The default value is true.
|
|
20
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
21
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
22
|
+
# webhook already carries the request's `id`.
|
|
23
|
+
# - `sales_rep_entity_ref` (Hash, required): Refers to the sales representative’s full
|
|
24
|
+
# information on the Employee, Vendor, or OtherName list. In a request, if a
|
|
25
|
+
# `sales_rep_entity_ref` aggregate includes both `full_name` and `list_id`, `full_name` will
|
|
26
|
+
# be ignored. Notice that you can’t supply a customer name here.
|
|
27
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
28
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
29
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
30
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
31
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
32
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
33
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
34
|
+
#
|
|
35
|
+
# @param connection_id [String]
|
|
36
|
+
# @param params [Hash] the fields above
|
|
37
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
38
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
39
|
+
# @return [Hash] the queued request
|
|
40
|
+
# @see https://docs.qubesync.com/api-reference/v2/sales-reps/create-sales-rep
|
|
41
|
+
def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
42
|
+
queue("sales_rep.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# List sales reps: GET /connections/{connection_id}/sales-reps (`sales_rep.query`).
|
|
46
|
+
#
|
|
47
|
+
# QuickBooks answers in one webhook.
|
|
48
|
+
#
|
|
49
|
+
# Params, sent as the query string:
|
|
50
|
+
# - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): Used in filters to select
|
|
51
|
+
# list objects based on whether or not they are currently enabled for use by QuickBooks. The
|
|
52
|
+
# default value is asActiveOnly, which selects only list objects that are active. Choose at
|
|
53
|
+
# most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
54
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
55
|
+
# combine with each other, not with the other choices.
|
|
56
|
+
# - `from_modified_date` (String): Filters results to objects modified on or after this
|
|
57
|
+
# timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
|
|
58
|
+
# date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or
|
|
59
|
+
# `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`,
|
|
60
|
+
# `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with
|
|
61
|
+
# each other, not with the other choices.
|
|
62
|
+
# - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
|
|
63
|
+
# list object. The `full_name` is the name prefixed by the names of each ancestor, for
|
|
64
|
+
# example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. Choose at most
|
|
65
|
+
# one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
66
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
67
|
+
# combine with each other, not with the other choices.
|
|
68
|
+
# - `include_ret_element` (Array<one of "EditSequence", "Initial", "IsActive", "ListID",
|
|
69
|
+
# "SalesRepEntityRef", "TimeCreated", "TimeModified">)
|
|
70
|
+
# - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
|
|
71
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
72
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id` are
|
|
73
|
+
# supplied in a request, QuickBooks uses `list_id` and ignores `full_name`. Choose at most
|
|
74
|
+
# one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
75
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
76
|
+
# combine with each other, not with the other choices.
|
|
77
|
+
# - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
|
|
78
|
+
# count of how many objects could possibly be returned, use the `meta_data` query
|
|
79
|
+
# attribute.) If you include a `max_returned` value, it must be at least 1. QuickBooks
|
|
80
|
+
# doesn't page this query: at most this many records come back, in one answer, with no sign
|
|
81
|
+
# of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the
|
|
82
|
+
# Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type`
|
|
83
|
+
# `response_too_large`), so narrow a large one with its filters. Choose at most one of:
|
|
84
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
85
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
86
|
+
# combine with each other, not with the other choices.
|
|
87
|
+
# - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
|
|
88
|
+
# `meta_data` attribute to control whether query responses include counts. Options are
|
|
89
|
+
# NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
|
|
90
|
+
# objects). Counts are approximate and may vary slightly if records are created or deleted
|
|
91
|
+
# during processing.
|
|
92
|
+
# - `name_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
|
|
93
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
94
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
95
|
+
# combine with each other, not with the other choices.
|
|
96
|
+
# - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
|
|
97
|
+
# to match.
|
|
98
|
+
# - `name` (String, required): The string to match.
|
|
99
|
+
# - `name_range_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
|
|
100
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
101
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
102
|
+
# combine with each other, not with the other choices.
|
|
103
|
+
# - `from_name` (String): The first name or item in the search range. If `from_name` is
|
|
104
|
+
# omitted, the range will begin with first name on the list.
|
|
105
|
+
# - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
|
|
106
|
+
# the range will end with last name on the list.
|
|
107
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
108
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
109
|
+
# webhook already carries the request's `id`.
|
|
110
|
+
# - `to_modified_date` (String): Filters results to objects modified on or before this
|
|
111
|
+
# timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
|
|
112
|
+
# date is provided, time defaults to end-of-day (23:59:59). Choose at most one of:
|
|
113
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
114
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
115
|
+
# combine with each other, not with the other choices.
|
|
116
|
+
#
|
|
117
|
+
# @param connection_id [String]
|
|
118
|
+
# @param params [Hash] the fields above
|
|
119
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
120
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
121
|
+
# @return [Hash] the queued request
|
|
122
|
+
# @see https://docs.qubesync.com/api-reference/v2/sales-reps/list-sales-reps
|
|
123
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
124
|
+
queue("sales_rep.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Update sales rep: PUT /connections/{connection_id}/sales-reps (`sales_rep.update`).
|
|
128
|
+
#
|
|
129
|
+
# QuickBooks answers in one webhook.
|
|
130
|
+
#
|
|
131
|
+
# Params, sent as the JSON body:
|
|
132
|
+
# - `edit_sequence` (String, required): `edit_sequence` is a server-generated revision token.
|
|
133
|
+
# It changes each time the object is updated. To modify an existing object, you must send
|
|
134
|
+
# the current `edit_sequence`. If your value is stale, the update is rejected to prevent
|
|
135
|
+
# overwriting newer changes.
|
|
136
|
+
# - `include_ret_element` (Array<one of "EditSequence", "ExternalGUID", "Initial", "IsActive",
|
|
137
|
+
# "ListID", "OwnerID", "SalesRepEntityRef", "TimeCreated", "TimeModified", "TxnID",
|
|
138
|
+
# "TxnNumber">)
|
|
139
|
+
# - `initial` (String): The initials of a sales representative’s name.
|
|
140
|
+
# - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
|
|
141
|
+
# QuickBooks. The default value is true.
|
|
142
|
+
# - `list_id` (String, required): `list_id` and `full_name` both identify a list object.
|
|
143
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
144
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id` are
|
|
145
|
+
# supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
146
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
147
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
148
|
+
# webhook already carries the request's `id`.
|
|
149
|
+
# - `sales_rep_entity_ref` (Hash): Refers to the sales representative’s full information on
|
|
150
|
+
# the Employee, Vendor, or OtherName list. In a request, if a `sales_rep_entity_ref`
|
|
151
|
+
# aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. Notice
|
|
152
|
+
# that you can’t supply a customer name here.
|
|
153
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
154
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
155
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
156
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
157
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
158
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
159
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
160
|
+
#
|
|
161
|
+
# @param connection_id [String]
|
|
162
|
+
# @param params [Hash] the fields above
|
|
163
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
164
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
165
|
+
# @return [Hash] the queued request
|
|
166
|
+
# @see https://docs.qubesync.com/api-reference/v2/sales-reps/update-sales-rep
|
|
167
|
+
def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
168
|
+
queue("sales_rep.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
169
|
+
end
|
|
170
|
+
end
|
|
171
|
+
end
|
|
172
|
+
end
|
|
@@ -0,0 +1,205 @@
|
|
|
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 sales tax code operations, reached as `client.sales_tax_code`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class SalesTaxCode < Base
|
|
9
|
+
# Create sales tax code: POST /connections/{connection_id}/sales-tax-codes
|
|
10
|
+
# (`sales_tax_code.create`).
|
|
11
|
+
#
|
|
12
|
+
# QuickBooks answers in one webhook.
|
|
13
|
+
#
|
|
14
|
+
# Params, sent as the JSON body:
|
|
15
|
+
# - `desc` (String): Desc gives a longer explanation of Name.
|
|
16
|
+
# - `include_ret_element` (Array<one of "Desc", "EditSequence", "ExternalGUID", "IsActive",
|
|
17
|
+
# "IsTaxable", "ItemPurchaseTaxRef", "ItemSalesTaxRef", "ListID", "Name", "OwnerID",
|
|
18
|
+
# "TimeCreated", "TimeModified", "TxnID", "TxnNumber">)
|
|
19
|
+
# - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
|
|
20
|
+
# QuickBooks. The default value is true.
|
|
21
|
+
# - `is_taxable` (Boolean, required): Indicates whether this sales-tax code is tracking
|
|
22
|
+
# taxable sales. For any particular sales-tax code, `is_taxable` can’t be modified once the
|
|
23
|
+
# sales-tax code has been used in a transaction. If the “Do You Charge Sales Tax?”
|
|
24
|
+
# preference is set to Yes within QuickBooks, the default value of `is_taxable` is true.
|
|
25
|
+
# - `item_purchase_tax_ref` (Hash): For future use with international versions of QuickBooks.
|
|
26
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
27
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
28
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
29
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
30
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
31
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
32
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
33
|
+
# - `item_sales_tax_ref` (Hash): An ItemSalesTax entry represents one tax rate paid to one tax
|
|
34
|
+
# agency. Use it when a transaction needs a single tax calculation. For multi-rate
|
|
35
|
+
# scenarios, use a sales-tax group instead. If both `full_name` and `list_id` are provided
|
|
36
|
+
# for `item_sales_tax_ref`, `list_id` is used.
|
|
37
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
38
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
39
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
40
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
41
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
42
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
43
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
44
|
+
# - `name` (String, required): Short name that will appear on sales forms to identify the tax
|
|
45
|
+
# status of an item. The Desc element gives a longer explanation of Name. Name must be
|
|
46
|
+
# unique, and it isn’t case-sensitive.
|
|
47
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
48
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
49
|
+
# webhook already carries the request's `id`.
|
|
50
|
+
#
|
|
51
|
+
# @param connection_id [String]
|
|
52
|
+
# @param params [Hash] the fields above
|
|
53
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
54
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
55
|
+
# @return [Hash] the queued request
|
|
56
|
+
# @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/create-sales-tax-code
|
|
57
|
+
def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
58
|
+
queue("sales_tax_code.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# List sales tax codes: GET /connections/{connection_id}/sales-tax-codes
|
|
62
|
+
# (`sales_tax_code.query`).
|
|
63
|
+
#
|
|
64
|
+
# QuickBooks answers in one webhook.
|
|
65
|
+
#
|
|
66
|
+
# Params, sent as the query string:
|
|
67
|
+
# - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): Used in filters to select
|
|
68
|
+
# list objects based on whether or not they are currently enabled for use by QuickBooks. The
|
|
69
|
+
# default value is asActiveOnly, which selects only list objects that are active. Choose at
|
|
70
|
+
# most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
71
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
72
|
+
# combine with each other, not with the other choices.
|
|
73
|
+
# - `from_modified_date` (String): Filters results to objects modified on or after this
|
|
74
|
+
# timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
|
|
75
|
+
# date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or
|
|
76
|
+
# `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`,
|
|
77
|
+
# `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with
|
|
78
|
+
# each other, not with the other choices.
|
|
79
|
+
# - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
|
|
80
|
+
# list object. The `full_name` is the name prefixed by the names of each ancestor, for
|
|
81
|
+
# example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. Choose at most
|
|
82
|
+
# one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
83
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
84
|
+
# combine with each other, not with the other choices.
|
|
85
|
+
# - `include_ret_element` (Array<one of "Desc", "EditSequence", "IsActive", "IsTaxable",
|
|
86
|
+
# "ItemPurchaseTaxRef", "ItemSalesTaxRef", "ListID", "Name", "TimeCreated", "TimeModified">)
|
|
87
|
+
# - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
|
|
88
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
89
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id` are
|
|
90
|
+
# supplied in a request, QuickBooks uses `list_id` and ignores `full_name`. Choose at most
|
|
91
|
+
# one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
92
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
93
|
+
# combine with each other, not with the other choices.
|
|
94
|
+
# - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
|
|
95
|
+
# count of how many objects could possibly be returned, use the `meta_data` query
|
|
96
|
+
# attribute.) If you include a `max_returned` value, it must be at least 1. QuickBooks
|
|
97
|
+
# doesn't page this query: at most this many records come back, in one answer, with no sign
|
|
98
|
+
# of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the
|
|
99
|
+
# Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type`
|
|
100
|
+
# `response_too_large`), so narrow a large one with its filters. Choose at most one of:
|
|
101
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
102
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
103
|
+
# combine with each other, not with the other choices.
|
|
104
|
+
# - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
|
|
105
|
+
# `meta_data` attribute to control whether query responses include counts. Options are
|
|
106
|
+
# NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
|
|
107
|
+
# objects). Counts are approximate and may vary slightly if records are created or deleted
|
|
108
|
+
# during processing.
|
|
109
|
+
# - `name_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
|
|
110
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
111
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
112
|
+
# combine with each other, not with the other choices.
|
|
113
|
+
# - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
|
|
114
|
+
# to match.
|
|
115
|
+
# - `name` (String, required): The string to match.
|
|
116
|
+
# - `name_range_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
|
|
117
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
118
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
119
|
+
# combine with each other, not with the other choices.
|
|
120
|
+
# - `from_name` (String): The first name or item in the search range. If `from_name` is
|
|
121
|
+
# omitted, the range will begin with first name on the list.
|
|
122
|
+
# - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
|
|
123
|
+
# the range will end with last name on the list.
|
|
124
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
125
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
126
|
+
# webhook already carries the request's `id`.
|
|
127
|
+
# - `to_modified_date` (String): Filters results to objects modified on or before this
|
|
128
|
+
# timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
|
|
129
|
+
# date is provided, time defaults to end-of-day (23:59:59). Choose at most one of:
|
|
130
|
+
# `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
|
|
131
|
+
# `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
|
|
132
|
+
# combine with each other, not with the other choices.
|
|
133
|
+
#
|
|
134
|
+
# @param connection_id [String]
|
|
135
|
+
# @param params [Hash] the fields above
|
|
136
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
137
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
138
|
+
# @return [Hash] the queued request
|
|
139
|
+
# @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/list-sales-tax-codes
|
|
140
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
141
|
+
queue("sales_tax_code.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Update sales tax code: PUT /connections/{connection_id}/sales-tax-codes
|
|
145
|
+
# (`sales_tax_code.update`).
|
|
146
|
+
#
|
|
147
|
+
# QuickBooks answers in one webhook.
|
|
148
|
+
#
|
|
149
|
+
# Params, sent as the JSON body:
|
|
150
|
+
# - `desc` (String): Desc gives a longer explanation of Name.
|
|
151
|
+
# - `edit_sequence` (String, required): `edit_sequence` is a server-generated revision token.
|
|
152
|
+
# It changes each time the object is updated. To modify an existing object, you must send
|
|
153
|
+
# the current `edit_sequence`. If your value is stale, the update is rejected to prevent
|
|
154
|
+
# overwriting newer changes.
|
|
155
|
+
# - `include_ret_element` (Array<one of "Desc", "EditSequence", "ExternalGUID", "IsActive",
|
|
156
|
+
# "IsTaxable", "ItemPurchaseTaxRef", "ItemSalesTaxRef", "ListID", "Name", "OwnerID",
|
|
157
|
+
# "TimeCreated", "TimeModified", "TxnID", "TxnNumber">)
|
|
158
|
+
# - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
|
|
159
|
+
# QuickBooks. The default value is true.
|
|
160
|
+
# - `is_taxable` (Boolean): Indicates whether this sales-tax code is tracking taxable sales.
|
|
161
|
+
# For any particular sales-tax code, `is_taxable` can’t be modified once the sales-tax code
|
|
162
|
+
# has been used in a transaction. If the “Do You Charge Sales Tax?” preference is set to Yes
|
|
163
|
+
# within QuickBooks, the default value of `is_taxable` is true.
|
|
164
|
+
# - `item_purchase_tax_ref` (Hash): For future use with international versions of QuickBooks.
|
|
165
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
166
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
167
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
168
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
169
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
170
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
171
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
172
|
+
# - `item_sales_tax_ref` (Hash): An ItemSalesTax entry represents one tax rate paid to one tax
|
|
173
|
+
# agency. Use it when a transaction needs a single tax calculation. For multi-rate
|
|
174
|
+
# scenarios, use a sales-tax group instead. If both `full_name` and `list_id` are provided
|
|
175
|
+
# for `item_sales_tax_ref`, `list_id` is used.
|
|
176
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
177
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
178
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
179
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
180
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
181
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
182
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
183
|
+
# - `list_id` (String, required): `list_id` and `full_name` both identify a list object.
|
|
184
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
185
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id` are
|
|
186
|
+
# supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
187
|
+
# - `name` (String): Short name that will appear on sales forms to identify the tax status of
|
|
188
|
+
# an item. The Desc element gives a longer explanation of Name. Name must be unique, and it
|
|
189
|
+
# isn’t case-sensitive.
|
|
190
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
191
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
192
|
+
# webhook already carries the request's `id`.
|
|
193
|
+
#
|
|
194
|
+
# @param connection_id [String]
|
|
195
|
+
# @param params [Hash] the fields above
|
|
196
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
197
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
198
|
+
# @return [Hash] the queued request
|
|
199
|
+
# @see https://docs.qubesync.com/api-reference/v2/sales-tax-codes/update-sales-tax-code
|
|
200
|
+
def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
201
|
+
queue("sales_tax_code.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
end
|
|
205
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
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 sales tax payable operations, reached as `client.sales_tax_payable`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class SalesTaxPayable < Base
|
|
9
|
+
# List sales tax payables: GET /connections/{connection_id}/sales-tax-payables
|
|
10
|
+
# (`sales_tax_payable.query`).
|
|
11
|
+
#
|
|
12
|
+
# QuickBooks answers in one webhook.
|
|
13
|
+
#
|
|
14
|
+
# Params, sent as the query string:
|
|
15
|
+
# - `as_of_date` (String): The date when the exchange rate was last changed.
|
|
16
|
+
# - `include_ret_element` (Array<one of "Amount", "PayeeEntityRef", "SalesTaxPayableLineRet">)
|
|
17
|
+
# - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
|
|
18
|
+
# `meta_data` attribute to control whether query responses include counts. Options are
|
|
19
|
+
# NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
|
|
20
|
+
# objects). Counts are approximate and may vary slightly if records are created or deleted
|
|
21
|
+
# during processing.
|
|
22
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
23
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
24
|
+
# webhook already carries the request's `id`.
|
|
25
|
+
#
|
|
26
|
+
# @param connection_id [String]
|
|
27
|
+
# @param params [Hash] the fields above
|
|
28
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
29
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
30
|
+
# @return [Hash] the queued request
|
|
31
|
+
# @see https://docs.qubesync.com/api-reference/v2/sales-tax-payables/list-sales-tax-payables
|
|
32
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
33
|
+
queue("sales_tax_payable.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|