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,399 @@
|
|
|
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 ar refund credit card operations, reached as `client.ar_refund_credit_card`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class ArRefundCreditCard < Base
|
|
9
|
+
# Create ar refund credit card: POST /connections/{connection_id}/ar-refund-credit-cards
|
|
10
|
+
# (`ar_refund_credit_card.create`).
|
|
11
|
+
#
|
|
12
|
+
# QuickBooks answers in one webhook.
|
|
13
|
+
#
|
|
14
|
+
# Params, sent as the JSON body:
|
|
15
|
+
# - `address` (Hash): If an address request fails, some combination of address fields might be
|
|
16
|
+
# too long. In a Check, BillPaymentCheck, or SalesTaxPaymentCheck message, Address is the
|
|
17
|
+
# address that will print on the check.
|
|
18
|
+
# - `addr1` (String): The first line of an address.
|
|
19
|
+
# - `addr2` (String): The second line of an address (if a second line is needed).
|
|
20
|
+
# - `addr3` (String): The third line of an address (if a third line is needed).
|
|
21
|
+
# - `addr4` (String): The fourth line of an address (if a fourth line is needed).
|
|
22
|
+
# - `addr5` (String): The fifth line of an address (if a fifth line is needed).
|
|
23
|
+
# - `city` (String): The city name in an address.
|
|
24
|
+
# - `country` (String): The country name in an address, or, in returned Host information
|
|
25
|
+
# (HostRet or HostInfo), the country for which this edition of QuickBooks was designed.
|
|
26
|
+
# (Possible values are US, CA, UK, and AU.)
|
|
27
|
+
# - `note` (String): In a BillAddress or ShipAddress aggregate, the Note field value is
|
|
28
|
+
# written at the bottom of the address in the form in which it appears, such as the
|
|
29
|
+
# invoice form.
|
|
30
|
+
# - `postal_code` (String): The postal code in an address.
|
|
31
|
+
# - `state` (String): The state name in an address.
|
|
32
|
+
# - `ar_account_ref` (Hash): `ar_account_ref` points to an Accounts Receivable account. If
|
|
33
|
+
# both `full_name` and `list_id` are provided, `full_name` is ignored.
|
|
34
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
35
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
36
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
37
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
38
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
39
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
40
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
41
|
+
# - `credit_card_txn_info` (Hash): Contains data from the credit card transaction used in the
|
|
42
|
+
# payment. This data originates from a previous qbmsXML credit card transaction. The data
|
|
43
|
+
# following the element `credit_card_txn_input_info`” data is the data from the original
|
|
44
|
+
# qbmsXML request. The “`credit_card_txn_result_info`” is the data from the original qbmsXML
|
|
45
|
+
# response.
|
|
46
|
+
# - `credit_card_txn_input_info` (Hash, required): This contains data originally supplied in
|
|
47
|
+
# the QBMS transaction request. This information block shouldn’t be used in CreditMemo
|
|
48
|
+
# requests for QuickBooks 2007 and new versions. Instead, use the ARRefundCreditCard
|
|
49
|
+
# request.
|
|
50
|
+
# - `commercial_card_code` (String): This optional field is used only for Visa and Master
|
|
51
|
+
# Card commercial cards. There are three types of these cards: purchase, corporate, and
|
|
52
|
+
# business. Normally, special lower transaction fee rates apply when these cards are
|
|
53
|
+
# used and this field is filled out. If this field is left blank, then the usual (and
|
|
54
|
+
# higher) discount rate applies.
|
|
55
|
+
# - `credit_card_address` (String): The address associated with this credit card.
|
|
56
|
+
# - `credit_card_number` (String, required): Credit-card number for this customer or this
|
|
57
|
+
# payment. Beginning with qbXML spec 6.0 and QuickBooks 2007, you must mask the credit
|
|
58
|
+
# card number with lower case “x” and no dashes. For example, xxxxxxxxxxxx1234.
|
|
59
|
+
# - `credit_card_postal_code` (String): The postal code associated with the address for
|
|
60
|
+
# this credit card.
|
|
61
|
+
# - `credit_card_txn_type` (one of "Authorization", "Capture", "Charge", "Refund",
|
|
62
|
+
# "VoiceAuthorization"): Indicates the QBMS transaction from which the current
|
|
63
|
+
# transaction data originated, for example, Charge, Authorization, Capture, Refund,
|
|
64
|
+
# VoiceAuthorization, or Void.
|
|
65
|
+
# - `expiration_month` (Integer, required): The month when the credit card expires.
|
|
66
|
+
# - `expiration_year` (Integer, required): The year when the credit card expires.
|
|
67
|
+
# - `name_on_card` (String, required): The name on the customer’s credit card.
|
|
68
|
+
# - `transaction_mode` (one of "CardNotPresent", "CardPresent"): Indicates whether this
|
|
69
|
+
# transaction came from a card swipe (tmCardPresent) or not (tmCardNotPresent).
|
|
70
|
+
# - `credit_card_txn_result_info` (Hash, required): This contains data returned in the QBMS
|
|
71
|
+
# transaction response. This information block shouldn’t be used in CreditMemo requests
|
|
72
|
+
# for QuickBooks 2007 and new versions. Instead, use the ARRefundCreditCard request.
|
|
73
|
+
# - `authorization_code` (String): The authorization code is returned from the credit card
|
|
74
|
+
# processor to indicate that the charge will be paid by the card issuer. In a voice
|
|
75
|
+
# authorization request (CustomerCreditCardVoiceAuthRq), the authorization code is
|
|
76
|
+
# supplied by the card issuer over the telephone.
|
|
77
|
+
# - `avs_street` (one of "Fail", "NotAvailable", "Pass"): This field contains the value
|
|
78
|
+
# avssPass if the street address supplied in the transaction request matches the
|
|
79
|
+
# customer’s address on file at the card issuer. It contains the value avssFail if there
|
|
80
|
+
# isn’t a match, or avssNotAvailable if the card issuer doesn’t support AVS. Note: This
|
|
81
|
+
# field was required in qbXML 4.1, but is optional in qbXML 5.0 and later.
|
|
82
|
+
# - `avs_zip` (one of "Fail", "NotAvailable", "Pass"): This field contains the value
|
|
83
|
+
# avszPass if the customer postal ZIP code supplied in the transaction request matches
|
|
84
|
+
# the customer’s postal code recognized at the card issuer. It contains the value
|
|
85
|
+
# avszFail if there isn’t a match, or avszNotAvailable if the card issuer doesn’t
|
|
86
|
+
# support AVS. Note: This field was required in qbXML 4.1, but is optional in qbXML 5.0
|
|
87
|
+
# and later.
|
|
88
|
+
# - `card_security_code_match` (one of "Fail", "NotAvailable", "Pass"): This field
|
|
89
|
+
# contains the value Pass if the card security code supplied in the transaction request
|
|
90
|
+
# matches the card security code recognized for that credit card number at the card
|
|
91
|
+
# issuer. It contains the value Fail if there isn’t a match.
|
|
92
|
+
# - `client_trans_id` (String): This value is returned from QBMS transactions for future
|
|
93
|
+
# use by the QuickBooks Reconciliation feature.
|
|
94
|
+
# - `credit_card_trans_id` (String, required): This transaction ID is returned from the
|
|
95
|
+
# credit card processor. You should save this value for any possible QBMS SDK
|
|
96
|
+
# transaction requests that need it, for example, CustomerCreditCardTxnVoidRq, or
|
|
97
|
+
# CustomerCreditCardCaptureRq.
|
|
98
|
+
# - `merchant_account_number` (String, required): This is the QBMS account number of the
|
|
99
|
+
# merchant who is running the transaction using the customer’s credit card. It is
|
|
100
|
+
# returned from the transaction request and should be stored for subsequent
|
|
101
|
+
# transactions, such as using it in the QB SDK SalesReceiptAdd, ReceivePaymentAdd,
|
|
102
|
+
# ARRefundCreditCard requests to save the transaction data in QuickBooks.
|
|
103
|
+
# - `payment_grouping_code` (Integer): Internal code needed for the QuickBooks
|
|
104
|
+
# reconciliation feature, if integrating with QuickBooks. This value is returned in the
|
|
105
|
+
# QBMS response to a QBMS transaction request, and must be subsequently supplied by your
|
|
106
|
+
# application in the QB SDK ReceivePaymentAdd or SalesReceiptAdd request.
|
|
107
|
+
# - `payment_status` (one of "Completed", "Unknown", required): Indicates payment
|
|
108
|
+
# processing status as known by QuickBooks/QBMS integration state. `psCompleted`
|
|
109
|
+
# indicates confirmed success; `psUnknown` indicates status could not be definitively
|
|
110
|
+
# confirmed.
|
|
111
|
+
# - `recon_batch_id` (String): This value is returned by QBMS from the transaction
|
|
112
|
+
# request, and is used internally by the QuickBooks/QBMS Recon (reconcile) feature. You
|
|
113
|
+
# should save this value without modification and include it in the QB SDK
|
|
114
|
+
# SalesReceiptAdd or ReceivePaymentAdd requests if you want to save the transaction data
|
|
115
|
+
# in QuickBooks.
|
|
116
|
+
# - `result_code` (Integer, required): This contains the status code returned in the
|
|
117
|
+
# original QBMS transaction response.
|
|
118
|
+
# - `result_message` (String, required): This contains the status message returned in the
|
|
119
|
+
# original QBMS transaction response.
|
|
120
|
+
# - `txn_authorization_stamp` (Integer): This value is used to support the credit card
|
|
121
|
+
# transaction Reconcile feature within QuickBooks.
|
|
122
|
+
# - `txn_authorization_time` (String, required): Timestamp indicating the time in which
|
|
123
|
+
# the card processor authorized the transaction.
|
|
124
|
+
# - `customer_ref` (Hash, required): `customer_ref` identifies a customer or customer job. If
|
|
125
|
+
# both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and
|
|
126
|
+
# ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the
|
|
127
|
+
# time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
|
|
128
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
129
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
130
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
131
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
132
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
133
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
134
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
135
|
+
# - `def_macro` (String): `def_macro` lets you assign a reusable name to a returned `txn_id`
|
|
136
|
+
# or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK
|
|
137
|
+
# 2.0+.
|
|
138
|
+
# - `exchange_rate` (Numeric): `exchange_rate` is the rate from this currency to the company’s
|
|
139
|
+
# home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks
|
|
140
|
+
# does not provide rates through the SDK. If your home currency is USD and internet access
|
|
141
|
+
# is available, rates can be downloaded in the QuickBooks UI via Lists > Currency >
|
|
142
|
+
# Activities > Download Latest Exchange Rates.
|
|
143
|
+
# - `external_guid` (String): Allows for the attachment of a user defined GUID value.
|
|
144
|
+
# - `include_ret_element` (Array<one of "ARAccountRef", "Address", "AddressBlock",
|
|
145
|
+
# "CreditCardTxnInfo", "CurrencyRef", "CustomerRef", "DataExtRet", "EditSequence",
|
|
146
|
+
# "ExchangeRate", "ExternalGUID", "ListID", "Memo", "OwnerID", "PaymentMethodRef",
|
|
147
|
+
# "RefNumber", "RefundAppliedToTxnRet", "RefundFromAccountRef", "TimeCreated",
|
|
148
|
+
# "TimeModified", "TotalAmount", "TotalAmountInHomeCurrency", "TxnDate", "TxnID",
|
|
149
|
+
# "TxnNumber">)
|
|
150
|
+
# - `memo` (String): Additional information.
|
|
151
|
+
# - `payment_method_ref` (Hash): `payment_method_ref` identifies how a payment is made (for
|
|
152
|
+
# example, cash, check, or card type). If both `full_name` and `list_id` are provided,
|
|
153
|
+
# `full_name` is ignored.
|
|
154
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
155
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
156
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
157
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
158
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
159
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
160
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
161
|
+
# - `ref_number` (String): `ref_number` is a user-managed transaction reference (for example,
|
|
162
|
+
# a check number). It can be edited and is not guaranteed to be globally unique. Some
|
|
163
|
+
# transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences
|
|
164
|
+
# and numbering state.
|
|
165
|
+
# - `refund_applied_to_txn_add` (Array<Hash>, required)
|
|
166
|
+
# - `refund_amount` (Numeric, required): Specifies the amount to be taken from the credit
|
|
167
|
+
# transaction you are linking via this aggregate. The amount specified in this aggregate
|
|
168
|
+
# can’t exceed the amount of the credit transaction you are linking. If you supply an
|
|
169
|
+
# amount that exceeds, you’ll get a runtime error.
|
|
170
|
+
# - `txn_id` (String, required): `txn_id` is the unique QuickBooks identifier for a
|
|
171
|
+
# transaction. Use it to reference that transaction in later requests. `txn_id` values are
|
|
172
|
+
# transaction-specific and should not be reused across unrelated transaction types.
|
|
173
|
+
# - `refund_from_account_ref` (Hash): In an ARRefundCreditCardAdd, the account which is the
|
|
174
|
+
# source of funds for the credit card refund. Normally this is Undeposited Funds. However,
|
|
175
|
+
# you can specify another account if you wish. If you specify nothing here, Undeposited
|
|
176
|
+
# Funds is used by default.
|
|
177
|
+
# - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
|
|
178
|
+
# object. The `full_name` is the name prefixed by the names of each ancestor, for example
|
|
179
|
+
# Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
180
|
+
# - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
|
|
181
|
+
# assigns `list_id` when the object is created. `list_id` values are unique within a list
|
|
182
|
+
# type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
|
|
183
|
+
# request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
184
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
185
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
186
|
+
# webhook already carries the request's `id`.
|
|
187
|
+
# - `txn_date` (String): The date of the transaction. In some cases, if you leave `txn_date`
|
|
188
|
+
# out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved
|
|
189
|
+
# transaction of the same type.
|
|
190
|
+
#
|
|
191
|
+
# @param connection_id [String]
|
|
192
|
+
# @param params [Hash] the fields above
|
|
193
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
194
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
195
|
+
# @return [Hash] the queued request
|
|
196
|
+
# @see https://docs.qubesync.com/api-reference/v2/ar-refund-credit-cards/create-ar-refund-credit-card
|
|
197
|
+
def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
198
|
+
queue("ar_refund_credit_card.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# List ar refund credit cards: GET /connections/{connection_id}/ar-refund-credit-cards
|
|
202
|
+
# (`ar_refund_credit_card.query`).
|
|
203
|
+
#
|
|
204
|
+
# QuickBooks answers in pages: one webhook per page, each with its `page`, the last with
|
|
205
|
+
# `iteration_state` `done`.
|
|
206
|
+
#
|
|
207
|
+
# Params, sent as the query string:
|
|
208
|
+
# - `account_filter` (Hash): Filters according to the account name or `list_id`. If the “Use
|
|
209
|
+
# account numbers” preference is enabled in the QuickBooks company file, you can specify an
|
|
210
|
+
# account number (instead of an account name) for `full_name` and get the account you’re
|
|
211
|
+
# looking for. But if numbers have been used as account names, confusion could arise. Choose
|
|
212
|
+
# at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set
|
|
213
|
+
# (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`,
|
|
214
|
+
# `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
|
|
215
|
+
# `txn_date_range_filter`). Members of a set combine with each other, not with the other
|
|
216
|
+
# choices.
|
|
217
|
+
# Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
|
|
218
|
+
# `full_name_with_children`.
|
|
219
|
+
# - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
|
|
220
|
+
# list object. The `full_name` is the name prefixed by the names of each ancestor, for
|
|
221
|
+
# example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
222
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
223
|
+
# specified object and its descendants. For names that don’t have children,
|
|
224
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
225
|
+
# - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
|
|
226
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
227
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id` are
|
|
228
|
+
# supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
229
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
230
|
+
# specified object and its descendants.
|
|
231
|
+
# - `currency_filter` (Hash): Filters by the specified currency. Choose at most one of:
|
|
232
|
+
# `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
|
|
233
|
+
# `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
|
|
234
|
+
# `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
|
|
235
|
+
# combine with each other, not with the other choices.
|
|
236
|
+
# Give at most one of: `list_id`, or `full_name`.
|
|
237
|
+
# - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
|
|
238
|
+
# list object. The `full_name` is the name prefixed by the names of each ancestor, for
|
|
239
|
+
# example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
240
|
+
# - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
|
|
241
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
242
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id` are
|
|
243
|
+
# supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
244
|
+
# - `entity_filter` (Hash): An entity refers to a person on the QuickBooks Customer list,
|
|
245
|
+
# Vendor list, Employee list, or Other Names list. You can use an EntityQuery request to get
|
|
246
|
+
# information about all the entities that are set up in the QuickBooks file. In an
|
|
247
|
+
# ARRefundCreditCard query, this must be a customer/customer job. Choose at most one of:
|
|
248
|
+
# `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
|
|
249
|
+
# `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
|
|
250
|
+
# `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
|
|
251
|
+
# combine with each other, not with the other choices.
|
|
252
|
+
# Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
|
|
253
|
+
# `full_name_with_children`.
|
|
254
|
+
# - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
|
|
255
|
+
# list object. The `full_name` is the name prefixed by the names of each ancestor, for
|
|
256
|
+
# example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
|
|
257
|
+
# - `full_name_with_children` (String): Allows you to filter for data that relates to the
|
|
258
|
+
# specified object and its descendants. For names that don’t have children,
|
|
259
|
+
# `full_name_with_children` is exactly the same as `full_name`.
|
|
260
|
+
# - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
|
|
261
|
+
# QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
|
|
262
|
+
# within a list type, not globally across all lists. If both `full_name` and `list_id` are
|
|
263
|
+
# supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
|
|
264
|
+
# - `list_id_with_children` (String): Allows you to filter for data that relates to the
|
|
265
|
+
# specified object and its descendants.
|
|
266
|
+
# - `include_line_items` (Boolean): This filter allows you to omit line items from a query
|
|
267
|
+
# response to get a smaller result. The default value is false, so line items are omitted by
|
|
268
|
+
# default. Set `include_line_items` to true to include line items in the response if you
|
|
269
|
+
# don’t mind getting a larger result.
|
|
270
|
+
# - `include_ret_element` (Array<one of "ARAccountRef", "Address", "AddressBlock",
|
|
271
|
+
# "CreditCardTxnInfo", "CurrencyRef", "CustomerRef", "DataExtRet", "EditSequence",
|
|
272
|
+
# "ExchangeRate", "ExternalGUID", "Memo", "PaymentMethodRef", "RefNumber",
|
|
273
|
+
# "RefundAppliedToTxnRet", "RefundFromAccountRef", "TimeCreated", "TimeModified",
|
|
274
|
+
# "TotalAmount", "TotalAmountInHomeCurrency", "TxnDate", "TxnID", "TxnNumber">)
|
|
275
|
+
# - `iterator` (Boolean): Page through every match: QuBe Sync asks QuickBooks for each page in
|
|
276
|
+
# turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by
|
|
277
|
+
# default, with pages of 100 records (25 with `include_line_items`); send `iterator=true`
|
|
278
|
+
# with `max_returned` for another size. Off when you send `iterator=false` (every match in
|
|
279
|
+
# one answer) or `max_returned` alone (at most that many, in one answer). It pages a
|
|
280
|
+
# filtered query only: with `ref_number`, `ref_number_case_sensitive` or `txn_id` every
|
|
281
|
+
# match comes back in one answer, so leave `iterator` out.
|
|
282
|
+
# - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
|
|
283
|
+
# count of how many objects could possibly be returned, use the `meta_data` query
|
|
284
|
+
# attribute.) If you include a `max_returned` value, it must be at least 1. The page size,
|
|
285
|
+
# with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap
|
|
286
|
+
# instead: at most this many records come back, in one answer, and QuickBooks doesn't say
|
|
287
|
+
# whether more matched. Choose at most one of: `txn_id`, or `ref_number`, or
|
|
288
|
+
# `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`,
|
|
289
|
+
# `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`,
|
|
290
|
+
# `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each
|
|
291
|
+
# other, not with the other choices.
|
|
292
|
+
# - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
|
|
293
|
+
# `meta_data` attribute to control whether query responses include counts. Options are
|
|
294
|
+
# NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
|
|
295
|
+
# objects). Counts are approximate and may vary slightly if records are created or deleted
|
|
296
|
+
# during processing.
|
|
297
|
+
# - `modified_date_range_filter` (Hash): Filters according to the dates when transactions were
|
|
298
|
+
# last modified. The `modified_date_range_filter` aggregate isn’t required to contain any
|
|
299
|
+
# elements, but if it is empty, we recommend that you leave it out altogether. Note that the
|
|
300
|
+
# time portion of the `from_modified_date` and `to_modified_date` fields wasn’t supported in
|
|
301
|
+
# qbXML version 1.0 or 1.1. Choose at most one of: `txn_id`, or `ref_number`, or
|
|
302
|
+
# `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`,
|
|
303
|
+
# `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`,
|
|
304
|
+
# `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each
|
|
305
|
+
# other, not with the other choices.
|
|
306
|
+
# - `from_modified_date` (String): Filters results to objects modified on or after this
|
|
307
|
+
# timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
|
|
308
|
+
# date is provided, time defaults to 00:00:00.
|
|
309
|
+
# - `to_modified_date` (String): Filters results to objects modified on or before this
|
|
310
|
+
# timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
|
|
311
|
+
# date is provided, time defaults to end-of-day (23:59:59).
|
|
312
|
+
# - `owner_id` (Array<String>): `owner_id` identifies who owns the data extension. Use 0 for
|
|
313
|
+
# QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned
|
|
314
|
+
# by an app. Keep private GUIDs confidential unless you intentionally share extensions
|
|
315
|
+
# across apps. If you do share them, both apps must use the same `owner_id` and
|
|
316
|
+
# `data_ext_name`, because that pair uniquely identifies the extension.
|
|
317
|
+
# - `ref_number` (Array<String>): `ref_number` is a user-managed transaction reference (for
|
|
318
|
+
# example, a check number). It can be edited and is not guaranteed to be globally unique.
|
|
319
|
+
# Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks
|
|
320
|
+
# preferences and numbering state. Choose at most one of: `txn_id`, or `ref_number`, or
|
|
321
|
+
# `ref_number_case_sensitive`, or the set (`account_filter`, `currency_filter`,
|
|
322
|
+
# `entity_filter`, `max_returned`, `modified_date_range_filter`, `ref_number_filter`,
|
|
323
|
+
# `ref_number_range_filter`, `txn_date_range_filter`). Members of a set combine with each
|
|
324
|
+
# other, not with the other choices.
|
|
325
|
+
# - `ref_number_case_sensitive` (Array<String>): Choose at most one of: `txn_id`, or
|
|
326
|
+
# `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
|
|
327
|
+
# `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
|
|
328
|
+
# `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
|
|
329
|
+
# combine with each other, not with the other choices.
|
|
330
|
+
# - `ref_number_filter` (Hash): Filters by `ref_number` range. Numeric-only bounds are
|
|
331
|
+
# compared numerically; otherwise comparison is lexicographic. Choose at most one of:
|
|
332
|
+
# `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
|
|
333
|
+
# `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
|
|
334
|
+
# `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
|
|
335
|
+
# combine with each other, not with the other choices.
|
|
336
|
+
# - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
|
|
337
|
+
# to match.
|
|
338
|
+
# - `ref_number` (String, required): `ref_number` is a user-managed transaction reference
|
|
339
|
+
# (for example, a check number). It can be edited and is not guaranteed to be globally
|
|
340
|
+
# unique. Some transaction types auto-populate `ref_number` when omitted, based on
|
|
341
|
+
# QuickBooks preferences and numbering state.
|
|
342
|
+
# - `ref_number_range_filter` (Hash): Filters by `ref_number` range. Numeric-only bounds are
|
|
343
|
+
# compared numerically; otherwise comparison is lexicographic. Choose at most one of:
|
|
344
|
+
# `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
|
|
345
|
+
# `currency_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
|
|
346
|
+
# `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
|
|
347
|
+
# combine with each other, not with the other choices.
|
|
348
|
+
# - `from_ref_number` (String): The first `ref_number` in the search range. If
|
|
349
|
+
# `from_ref_number` is omitted, the range will begin with first number on the list.
|
|
350
|
+
# - `to_ref_number` (String): The final `ref_number` in the search range. If `to_ref_number`
|
|
351
|
+
# is omitted, the range will end with last number on the list.
|
|
352
|
+
# - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
|
|
353
|
+
# `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
|
|
354
|
+
# webhook already carries the request's `id`.
|
|
355
|
+
# - `txn_date_range_filter` (Hash): Filters according to the original transaction dates.
|
|
356
|
+
# Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the
|
|
357
|
+
# set (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`,
|
|
358
|
+
# `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
|
|
359
|
+
# `txn_date_range_filter`). Members of a set combine with each other, not with the other
|
|
360
|
+
# choices.
|
|
361
|
+
# Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
|
|
362
|
+
# - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
|
|
363
|
+
# "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
|
|
364
|
+
# "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
|
|
365
|
+
# "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
|
|
366
|
+
# "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
|
|
367
|
+
# "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
|
|
368
|
+
# "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
|
|
369
|
+
# "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
|
|
370
|
+
# "ThisWeekToDate", "Today", "Yesterday"): `date_macro` filters by transaction date (not
|
|
371
|
+
# last-modified date). Do not combine `date_macro` with
|
|
372
|
+
# `from_modified_date`/`to_modified_date` in the same query filter set.
|
|
373
|
+
# - `from_txn_date` (String): Selects transactions created on or after this date. Both
|
|
374
|
+
# `from_txn_date` and `to_txn_date` must be between 01/01/1901 and 12/31/9999.If you omit
|
|
375
|
+
# `from_txn_date`, it will be set to 1970-01-01 (1969-12-31 PST).
|
|
376
|
+
# - `to_txn_date` (String): Selects transactions created on or before this date. Both
|
|
377
|
+
# `to_txn_date` and `from_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit
|
|
378
|
+
# `to_txn_date`, it will be set to 2038-01-19 (2038-01-18 PST).
|
|
379
|
+
# - `txn_id` (Array<String>): `txn_id` is the unique QuickBooks identifier for a transaction.
|
|
380
|
+
# Use it to reference that transaction in later requests. `txn_id` values are
|
|
381
|
+
# transaction-specific and should not be reused across unrelated transaction types. Choose
|
|
382
|
+
# at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the set
|
|
383
|
+
# (`account_filter`, `currency_filter`, `entity_filter`, `max_returned`,
|
|
384
|
+
# `modified_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
|
|
385
|
+
# `txn_date_range_filter`). Members of a set combine with each other, not with the other
|
|
386
|
+
# choices.
|
|
387
|
+
#
|
|
388
|
+
# @param connection_id [String]
|
|
389
|
+
# @param params [Hash] the fields above
|
|
390
|
+
# @param webhook_url [String] where QuBe Sync sends the answer
|
|
391
|
+
# @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
|
|
392
|
+
# @return [Hash] the queued request
|
|
393
|
+
# @see https://docs.qubesync.com/api-reference/v2/ar-refund-credit-cards/list-ar-refund-credit-cards
|
|
394
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
395
|
+
queue("ar_refund_credit_card.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
396
|
+
end
|
|
397
|
+
end
|
|
398
|
+
end
|
|
399
|
+
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 bar code operations, reached as `client.bar_code`. Each queues a request and
|
|
7
|
+
# returns it (the response's `data`); the answer comes to `webhook_url`.
|
|
8
|
+
class BarCode < Base
|
|
9
|
+
# List bar codes: GET /connections/{connection_id}/bar-codes (`bar_code.query`).
|
|
10
|
+
#
|
|
11
|
+
# QuickBooks answers in one webhook.
|
|
12
|
+
#
|
|
13
|
+
# Params, sent as the query string:
|
|
14
|
+
# - `bar_code_value` (Array<String>)
|
|
15
|
+
# - `iterator` (Boolean): Page through every result: QuBe Sync asks QuickBooks for each page
|
|
16
|
+
# in turn and sends each to your `webhook_url` as it arrives, all with the same `id`.
|
|
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/bar-codes/list-bar-codes
|
|
32
|
+
def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
|
|
33
|
+
queue("bar_code.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|