avatax 26.6.0 → 26.8.3

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bb79a9f4603321ed83713aa67ec0e32e37f649d8a13eb5d7a57f5b97c001c55f
4
- data.tar.gz: fe20a61f2dfcef13b8fe611c40778b3d31933dcbfc7128fb6c4c9ad42b155f72
3
+ metadata.gz: a3e1472788c94b587248cf0936bd15f9a5dce475f72f8f3917612403e8b7b087
4
+ data.tar.gz: 717b166329c75462d34f9e47f852955980f1d51c4bfead90510d54edb03cf62c
5
5
  SHA512:
6
- metadata.gz: 2bbc3af857171c4380fd509e5e95f66a8a6c6cc4b0d23757e7dca79e29e48fcb56a72b969918341a987fa59599fc28d399b2163cbc50ede94862bf639fefa7be
7
- data.tar.gz: d1c3d9e022a9a6c9aaf5c32a7762633b868a9157537f5b7b546831d3aef59813c2ed0c00ee8fdac824ad350b1c2c0190e533c38317bb29df4f36646ded7093e0
6
+ metadata.gz: 05725ffcfaf3235c09db4cce6b5d1e7a29c8ba67ecdcd64f847aadf047de8a1e733f6725249205bd794a4b5eb69c99fcf64953e5311962b8defee288b4fc724f
7
+ data.tar.gz: b0af7834d8f9b22a7bfac90edbbd81a7d48aa620366985c4c7da6b0c85a949166e0fe214146077b9c4adf237acdfebb986182a64692959a87cb22e9e2ef6dfa0
@@ -69,6 +69,10 @@ module AvaTax
69
69
  # required, please use the
70
70
  # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
71
71
  #
72
+ # Set `skipTransactionValidation` to true to defer transaction type, company code, and
73
+ # nested model validation until BatchV2 processes each transaction. Per-transaction
74
+ # validation failures are then written to the batch error file without blocking upload.
75
+ #
72
76
  # The maximum content length of the request body is limited to 28.6 MB. If this limit
73
77
  # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
74
78
  # the API is called from a browser). In this situation, please split the request into
@@ -133,6 +133,8 @@ module AvaTax
133
133
  # * attributes - Retrieves all attributes applied to the certificate.
134
134
  # * histories - Retrieves the certificate update history
135
135
  # * jobs - Retrieves the jobs for this certificate
136
+ # * jobs.phases - Retrieves the jobs along with their phases
137
+ # * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase
136
138
  # * logs - Retrieves the certificate log
137
139
  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
138
140
  # * custom_fields - Retrieves custom fields set for this certificate
@@ -150,7 +152,7 @@ module AvaTax
150
152
  # Swagger Name: AvaTaxClient
151
153
  # @param companyId [Integer] The ID number of the company that recorded this certificate
152
154
  # @param id [Integer] The unique ID number of this certificate
153
- # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
155
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * jobs.phases - Retrieves the jobs along with their phases * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
154
156
  # @return [Object]
155
157
  def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
156
158
  get(path, options, AvaTax::VERSION) end
@@ -262,6 +264,37 @@ module AvaTax
262
264
  def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
263
265
  get(path, {}, AvaTax::VERSION) end
264
266
 
267
+ # List the certificate tax-type hierarchy available to this company
268
+ #
269
+ # Returns the TPS multi-tax type hierarchy that is applicable when configuring exemption
270
+ # certificates for the given country. The returned tax types can be used to populate
271
+ # `taxTypeMappings` entries on a certificate jurisdiction via POST / PUT certificate.
272
+ #
273
+ # This endpoint is scoped to the certificate (CertCapture) domain and does not return the
274
+ # generic AvaTax tax-type catalog. For the generic catalog see the `Definitions` APIs.
275
+ #
276
+ # `country` is a mandatory query parameter.
277
+ #
278
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
279
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
280
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
281
+ # certificate storage for this company, call `RequestCertificateSetup`.
282
+ #
283
+ # ### Security Policies
284
+ #
285
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
286
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
287
+ # Swagger Name: AvaTaxClient
288
+ # @param companyId [Integer] The ID number of the company
289
+ # @param country [String] Required. ISO-2 country code used to filter the tax-type hierarchy (e.g., "US").
290
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxTypeId, country, taxSubTypeDetails
291
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
292
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
293
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
294
+ # @return [FetchResult]
295
+ def list_certificate_tax_types(companyId, options={}) path = "/api/v2/companies/#{companyId}/certificates/taxtypes"
296
+ get(path, options, AvaTax::VERSION) end
297
+
265
298
  # List customers linked to this certificate
266
299
  #
267
300
  # List all customers linked to this certificate.
@@ -355,6 +388,8 @@ module AvaTax
355
388
  # * attributes - Retrieves all attributes applied to the certificate.
356
389
  # * histories - Retrieves the certificate update history
357
390
  # * jobs - Retrieves the jobs for this certificate
391
+ # * jobs.phases - Retrieves the jobs along with their phases
392
+ # * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase
358
393
  # * logs - Retrieves the certificate log
359
394
  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
360
395
  # * custom_fields - Retrieves custom fields set for this certificate
@@ -371,8 +406,8 @@ module AvaTax
371
406
  # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
372
407
  # Swagger Name: AvaTaxClient
373
408
  # @param companyId [Integer] The ID number of the company to search
374
- # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
375
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages
409
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * jobs.phases - Retrieves the jobs along with their phases * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
410
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
376
411
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
377
412
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
378
413
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -0,0 +1,103 @@
1
+ module AvaTax
2
+ class Client
3
+ module CurrencyRoundingRules
4
+
5
+
6
+ # Create one or more currency rounding rules
7
+ #
8
+ # Create one or more currency rounding rules for this account. Each rule sets the rounding
9
+ # precision for a currency over an effective-date window.
10
+ #
11
+ # Windows for the same currency may overlap - for a given tax date the rule with the latest
12
+ # `effDate` whose window contains that date applies. Two rules that share a `currencyCode`
13
+ # and `effDate` are ambiguous and are rejected, whether the duplicate is against an existing
14
+ # rule or against another rule in the same request.
15
+ #
16
+ # A rule can only be created for a currency that already has an Avalara system default (see
17
+ # `GET api/v2/definitions/currencyroundingrules`).
18
+ #
19
+ # ### Security Policies
20
+ #
21
+ # * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
22
+ # Swagger Name: AvaTaxClient
23
+ # @param accountId [Integer] The unique ID number of the account that owns these currency rounding rules.
24
+ # @param model [AccountCurrencyRoundingRuleModel[]] The currency rounding rule object or objects you wish to create.
25
+ # @return [AccountCurrencyRoundingRuleModel[]]
26
+ def create_currency_rounding_rules(accountId, model) path = "/api/v2/accounts/#{accountId}/currencyroundingrules"
27
+ post(path, model, {}, AvaTax::VERSION) end
28
+
29
+ # Delete a single currency rounding rule
30
+ #
31
+ # Deletes the currency rounding rule identified by this URL. After deletion, calculation for
32
+ # that currency falls back to the Avalara default rule (or standard decimal precision if none).
33
+ #
34
+ # ### Security Policies
35
+ #
36
+ # * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
37
+ # Swagger Name: AvaTaxClient
38
+ # @param accountId [Integer] The unique ID number of the account that owns this currency rounding rule.
39
+ # @param id [Integer] The unique ID number of the currency rounding rule to delete.
40
+ # @return [ErrorDetail[]]
41
+ def delete_currency_rounding_rule(accountId, id) path = "/api/v2/accounts/#{accountId}/currencyroundingrules/#{id}"
42
+ delete(path, {}, AvaTax::VERSION) end
43
+
44
+ # Retrieve a single currency rounding rule
45
+ #
46
+ # Retrieves a single currency rounding rule identified by this URL.
47
+ #
48
+ # ### Security Policies
49
+ #
50
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
51
+ # Swagger Name: AvaTaxClient
52
+ # @param accountId [Integer] The ID of the account that owns this currency rounding rule.
53
+ # @param id [Integer] The unique ID number of the currency rounding rule to retrieve.
54
+ # @return [Object]
55
+ def get_currency_rounding_rule(accountId, id) path = "/api/v2/accounts/#{accountId}/currencyroundingrules/#{id}"
56
+ get(path, {}, AvaTax::VERSION) end
57
+
58
+ # Retrieve all currency rounding rules for this account.
59
+ #
60
+ # Lists all account-specific currency rounding rules for this account.
61
+ #
62
+ # Only rules created for this account are returned. When no rule exists for a currency on a
63
+ # transaction's tax date, the tax engine automatically applies the Avalara system default for
64
+ # that currency; if no system default exists, standard decimal precision is used (no rounding).
65
+ #
66
+ # Each rule's `precision` is `0` (whole currency unit) or `2` (standard decimal cents).
67
+ #
68
+ # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
69
+ # Paginate your results using the `$top`, `$skip`, and `$orderBy` parameters.
70
+ #
71
+ # ### Security Policies
72
+ #
73
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
74
+ # Swagger Name: AvaTaxClient
75
+ # @param accountId [Integer] The ID of the account whose currency rounding rules you wish to list.
76
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* createdDate, createdUserId, modifiedUserId
77
+ # @param include [String] A comma separated list of additional data to retrieve.
78
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
79
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
80
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
81
+ # @return [FetchResult]
82
+ def list_currency_rounding_rules(accountId, options={}) path = "/api/v2/accounts/#{accountId}/currencyroundingrules"
83
+ get(path, options, AvaTax::VERSION) end
84
+
85
+ # Update a currency rounding rule
86
+ #
87
+ # Replace the existing currency rounding rule at this URL with an updated object.
88
+ #
89
+ # All data from the existing object will be replaced with data in the object you PUT.
90
+ #
91
+ # ### Security Policies
92
+ #
93
+ # * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
94
+ # Swagger Name: AvaTaxClient
95
+ # @param accountId [Integer] The unique ID number of the account that owns this currency rounding rule.
96
+ # @param id [Integer] The unique ID number of the currency rounding rule to replace.
97
+ # @param model [Object] The new currency rounding rule object to store.
98
+ # @return [Object]
99
+ def update_currency_rounding_rule(accountId, id, model) path = "/api/v2/accounts/#{accountId}/currencyroundingrules/#{id}"
100
+ put(path, model, {}, AvaTax::VERSION) end
101
+ end
102
+ end
103
+ end
@@ -3,6 +3,27 @@ module AvaTax
3
3
  module Customers
4
4
 
5
5
 
6
+ # Add ship-to states to a customer
7
+ #
8
+ # Adds one or more ship-to states to the specified customer.
9
+ #
10
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
11
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
12
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
13
+ # certificate storage for this company, call `RequestCertificateSetup`.
14
+ #
15
+ # ### Security Policies
16
+ #
17
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
18
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
19
+ # Swagger Name: AvaTaxClient
20
+ # @param companyId [Integer] The unique ID number of the company that recorded this customer
21
+ # @param customerCode [String] The unique code representing this customer
22
+ # @param model [StateModel[]] The list of ship-to states to add to this customer
23
+ # @return [FetchResult]
24
+ def add_ship_to_states_for_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/shiptostate"
25
+ post(path, model, {}, AvaTax::VERSION) end
26
+
6
27
  # Create customers for this company
7
28
  #
8
29
  # Create one or more customers for this company.
@@ -276,7 +297,7 @@ module AvaTax
276
297
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
277
298
  # @param customerCode [String] The unique code representing this customer
278
299
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
279
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages
300
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
280
301
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
281
302
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
282
303
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -324,6 +345,26 @@ module AvaTax
324
345
  def list_in_active_certificates_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/inactive"
325
346
  get(path, {}, AvaTax::VERSION) end
326
347
 
348
+ # List ship-to states linked to a customer
349
+ #
350
+ # Retrieves the ship-to states associated with the specified customer.
351
+ #
352
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
353
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
354
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
355
+ # certificate storage for this company, call `RequestCertificateSetup`.
356
+ #
357
+ # ### Security Policies
358
+ #
359
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
360
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
361
+ # Swagger Name: AvaTaxClient
362
+ # @param companyId [Integer] The unique ID number of the company that recorded this customer
363
+ # @param customerCode [String] The unique code representing this customer
364
+ # @return [FetchResult]
365
+ def list_ship_to_states_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/shiptostate"
366
+ get(path, {}, AvaTax::VERSION) end
367
+
327
368
  # List valid certificates for a location
328
369
  #
329
370
  # List valid certificates linked to a customer in a particular country and region.
@@ -398,6 +439,27 @@ module AvaTax
398
439
  def query_customers(companyId, options={}) path = "/api/v2/companies/#{companyId}/customers"
399
440
  get(path, options, AvaTax::VERSION) end
400
441
 
442
+ # Remove ship-to states from a customer
443
+ #
444
+ # Removes one or more ship-to states from the specified customer.
445
+ #
446
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
447
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
448
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
449
+ # certificate storage for this company, call `RequestCertificateSetup`.
450
+ #
451
+ # ### Security Policies
452
+ #
453
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
454
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
455
+ # Swagger Name: AvaTaxClient
456
+ # @param companyId [Integer] The unique ID number of the company that recorded this customer
457
+ # @param customerCode [String] The unique code representing this customer
458
+ # @param model [StateModel[]] The list of ship-to states to remove from this customer
459
+ # @return [FetchResult]
460
+ def remove_ship_to_states_for_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/shiptostate"
461
+ delete(path, model, {}, AvaTax::VERSION) end
462
+
401
463
  # Unlink attributes from a customer
402
464
  #
403
465
  # Unlink one or many attributes from a customer.
@@ -42,7 +42,7 @@ module AvaTax
42
42
  #
43
43
  #
44
44
  # Swagger Name: AvaTaxClient
45
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* attributesUsed
45
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* attributesUsed, parameterMetadata
46
46
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
47
47
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
48
48
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -114,7 +114,7 @@ module AvaTax
114
114
  # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
115
115
  # check and provision account.
116
116
  # Swagger Name: AvaTaxClient
117
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, companyId, name, tag, description, created, modified, region, country
117
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, companyId, tag, description, created, modified, region, country
118
118
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
119
119
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
120
120
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -270,6 +270,25 @@ module AvaTax
270
270
  def list_currencies(options={}) path = "/api/v2/definitions/currencies"
271
271
  get(path, options, AvaTax::VERSION) end
272
272
 
273
+ # List the Avalara system default currency rounding rules.
274
+ #
275
+ # Lists the Avalara system default currency rounding rules - the rounding Avalara applies to
276
+ # a currency when an account has no rule of its own.
277
+ #
278
+ # Only currencies in this list may have an account-specific
279
+ # `AccountCurrencyRoundingRuleModel` created for them.
280
+ #
281
+ # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
282
+ # Paginate your results using the `$top`, `$skip`, and `$orderBy` parameters.
283
+ # Swagger Name: AvaTaxClient
284
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
285
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
286
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
287
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
288
+ # @return [FetchResult]
289
+ def list_currency_rounding_rule_defaults(options={}) path = "/api/v2/definitions/currencyroundingrules"
290
+ get(path, options, AvaTax::VERSION) end
291
+
273
292
  # Retrieve the full list of Avalara-supported entity use codes
274
293
  #
275
294
  # Returns the full list of Avalara-supported entity use codes.
@@ -365,6 +384,10 @@ module AvaTax
365
384
  # It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
366
385
  # jurisdiction in AvaTax.
367
386
  #
387
+ # You can widen the search by supplying the optional `radius` parameter (in miles). Supported values are
388
+ # 5 (default), 10, 20, 30, and 40. If the desired tax region is not found at 5 miles, retry with a larger radius.
389
+ # This only affects tax-region retrieval for this request; it does not change tax calculation once a region is selected.
390
+ #
368
391
  # The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
369
392
  # Swagger Name: AvaTaxClient
370
393
  # @param line1 [String] The first address line portion of this address.
@@ -374,6 +397,7 @@ module AvaTax
374
397
  # @param region [String] The region, state, or province code portion of this address.
375
398
  # @param postalCode [String] The postal code or zip code portion of this address.
376
399
  # @param country [String] The two-character ISO-3166 code of the country portion of this address.
400
+ # @param radius [Integer] Optional. The search radius in miles used to find nearby tax regions. Allowed values are 5, 10, 20, 30, and 40; when omitted the default of 5 miles is used. A larger radius widens the search for this request only and does not change the default behavior for other requests. Any other value is rejected with a validation error.
377
401
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* country, Jurisdictions
378
402
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
379
403
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -1195,6 +1219,9 @@ module AvaTax
1195
1219
  # @param taxTypeId [String] The taxtype for which you want to retrieve the unitofbasis information
1196
1220
  # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the unitofbasis information
1197
1221
  # @param rateTypeId [String] The ratetype for which you want to retrieve the unitofbasis information
1222
+ # @param state [String] Optional. The State/region (e.g. ```CO```) to narrow the unitofbasis results to a specific jurisdiction. When omitted, results are not narrowed by state.
1223
+ # @param jurisTypeId [String] Optional. The jurisdiction type to filter by. Accepted values are ```STA``` (state), ```CTY``` (county), ```CIT``` (city), or ```STJ``` (special jurisdiction). When omitted, results are not narrowed by jurisdiction type.
1224
+ # @param jurisCode [String] Optional. The local jurisdiction code to filter by (used together with state/jurisTypeId). When omitted, results are not narrowed by jurisdiction code.
1198
1225
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
1199
1226
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
1200
1227
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -3,32 +3,31 @@ module AvaTax
3
3
  module EcoNexusThreshold
4
4
 
5
5
 
6
- # List economic nexus threshold statuses for a company
6
+ # Retrieve economic nexus threshold statuses for a company
7
7
  #
8
- # Returns precomputed economic nexus threshold statuses for a company, sourced from a cache
9
- # refreshed weekly from Snowflake.
8
+ # Retrieve the economic nexus threshold status for each US state in which activity has been
9
+ # evaluated for this company.
10
10
  #
11
- # When the optional `region` query parameter is provided, only the matching jurisdiction row is included in `states`.
12
- # If no row exists for that company and region, `states` is an empty array (still 200 OK).
11
+ # Each entry in `states` describes the measurement window used, the sales and transaction
12
+ # thresholds that apply to that state, the company's totals for the window, and whether
13
+ # the threshold has been met.
13
14
  #
14
- # TPS currently binds this filter as query parameter `state`; use the same value. If the public contract standardizes on `region`,
15
- # TPS or api-gateway should accept or rewrite `region` so filtering still applies.
15
+ # Threshold statuses are evaluated on a recurring schedule rather than at request time.
16
+ # Use `lastRefreshedAt` to determine how current the returned data is; when it is absent
17
+ # from the response, the age of the data is not known.
16
18
  #
17
- # Production traffic is served by TPS; api-gateway should route this path to TPS.
19
+ # When the optional `region` query parameter is provided, only the matching state is included
20
+ # in `states`. If no threshold status exists for that company and region, `states` is returned
21
+ # as an empty array with a 200 response.
18
22
  #
19
- # This endpoint requires the `NexusFetch` permission. If EcoNexus is not configured in TPS or the cache has not loaded, TPS returns 503.
23
+ # Requires the `NexusFetch` permission for the target company.
20
24
  #
21
25
  # ### Security Policies
22
26
  #
23
27
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
24
28
  # Swagger Name: AvaTaxClient
25
- # @param companyId [Integer] The Avalara company identifier.
26
- # @param region [String] Optional two-letter US state/region postal code (case-insensitive), same meaning as the `state` column in the data store. When provided, `states` contains at most one item; if there is no data for that company and region, `states` is an empty array (200 OK).
27
- # @param include [String] Standard Avalara `$include` query option (see other v2 list APIs).
28
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
29
- # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
30
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
31
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
29
+ # @param companyId [Integer] The ID of the company to retrieve threshold statuses for.
30
+ # @param region [String] Optional two-letter US state postal code used to filter the results (case-insensitive). When provided, `states` contains at most one entry, matched against the `region` field of each entry. Must be exactly two characters; otherwise this endpoint returns 400.
32
31
  # @return [Object]
33
32
  def get_eco_nexus_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/econexusthresholds"
34
33
  get(path, options, AvaTax::VERSION) end
@@ -875,22 +875,23 @@ module AvaTax
875
875
  #
876
876
  # You can specify a comma-separated list of countries in the `hsCodeDoesNotExistsInCountries` query parameter if you want to filter items on the basis of whether an HS code does not exist for the provided countries.
877
877
  #
878
+ # `tagName`, `itemStatus`, `taxCodeRecommendationStatus`, `hsCodeClassificationStatus`, `hsCodeExistsInCountries`, and `hsCodeDoesNotExistsInCountries`
879
+ # are mutually exclusive: if more than one is supplied in the same request, only the first one in that listed order is applied and the rest are ignored.
880
+ # `tagName`, `itemStatus`, `taxCodeRecommendationStatus`, and `hsCodeClassificationStatus` require a `companyId`;
881
+ # they are not supported on the cross-company `QueryItems` endpoint.
882
+ #
878
883
  # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
879
884
  #
880
885
  # * Parameters
881
886
  # * Classifications
882
887
  # * Tags
883
- # * Properties
884
- # * TaxCodeRecommendationStatus
885
- # * HsCodeClassificationStatus
886
- # * TaxCodeDetails
887
888
  #
888
889
  # ### Security Policies
889
890
  #
890
891
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
891
892
  # Swagger Name: AvaTaxClient
892
893
  # @param companyId [Integer] The ID of the company that defined these items
893
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
894
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
894
895
  # @param include [String] A comma separated list of additional data to retrieve.
895
896
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
896
897
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -969,7 +970,7 @@ module AvaTax
969
970
  #
970
971
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
971
972
  # Swagger Name: AvaTaxClient
972
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
973
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
973
974
  # @param include [String] A comma separated list of additional data to retrieve.
974
975
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
975
976
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -1026,7 +1027,7 @@ module AvaTax
1026
1027
  # Swagger Name: AvaTaxClient
1027
1028
  # @param companyId [Integer] The ID of the company that defined these items.
1028
1029
  # @param tag [String] The master tag to be associated with item.
1029
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
1030
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
1030
1031
  # @param include [String] A comma separated list of additional data to retrieve.
1031
1032
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
1032
1033
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -16,7 +16,7 @@ module AvaTax
16
16
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
17
17
  # Swagger Name: AvaTaxClient
18
18
  # @param companyId [Integer] The ID of the company for which you want to create the registration.
19
- # @param model [Object] The webhook registration details to create.
19
+ # @param model [ItemReverseSyncRegistrationInputModel[]] The webhook registration details to create.
20
20
  # @return [Object]
21
21
  def create_reverse_sync_registration(companyId, model) path = "/api/v2/connector-sync/companies/#{companyId}/registrations"
22
22
  post(path, model, {}, AvaTax::VERSION) end
@@ -0,0 +1,197 @@
1
+ module AvaTax
2
+ class Client
3
+ module Jobs
4
+
5
+
6
+ # Create a new job for a company
7
+ #
8
+ # ### Security Policies
9
+ #
10
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
11
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
12
+ # Swagger Name: AvaTaxClient
13
+ # @param companyId [Integer] The unique ID number of the company
14
+ # @param model [Object] The job to create
15
+ # @return [Object]
16
+ def create_job(companyId, model) path = "/api/v2/companies/#{companyId}/jobs"
17
+ post(path, model, {}, AvaTax::VERSION) end
18
+
19
+ # Create a new phase on a job
20
+ #
21
+ # ### Security Policies
22
+ #
23
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
24
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
25
+ # Swagger Name: AvaTaxClient
26
+ # @param companyId [Integer] The unique ID number of the company
27
+ # @param jobId [Integer] The unique ID number of the job
28
+ # @param model [Object] The phase to create
29
+ # @return [Object]
30
+ def create_job_phase(companyId, jobId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases"
31
+ post(path, model, {}, AvaTax::VERSION) end
32
+
33
+ # Create a new task on a phase
34
+ #
35
+ # ### Security Policies
36
+ #
37
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
38
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
39
+ # Swagger Name: AvaTaxClient
40
+ # @param companyId [Integer] The unique ID number of the company
41
+ # @param jobId [Integer] The unique ID number of the job
42
+ # @param phaseId [Integer] The unique ID number of the phase
43
+ # @param model [Object] The task to create
44
+ # @return [Object]
45
+ def create_job_task(companyId, jobId, phaseId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}/tasks"
46
+ post(path, model, {}, AvaTax::VERSION) end
47
+
48
+ # Delete a job
49
+ #
50
+ # ### Security Policies
51
+ #
52
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
53
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
54
+ # Swagger Name: AvaTaxClient
55
+ # @param companyId [Integer] The unique ID number of the company
56
+ # @param id [Integer] The unique ID number of the job to delete
57
+ # @return [Object]
58
+ def delete_job(companyId, id) path = "/api/v2/companies/#{companyId}/jobs/#{id}"
59
+ delete(path, {}, AvaTax::VERSION) end
60
+
61
+ # Delete a phase from a job
62
+ #
63
+ # ### Security Policies
64
+ #
65
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
66
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
67
+ # Swagger Name: AvaTaxClient
68
+ # @param companyId [Integer] The unique ID number of the company
69
+ # @param jobId [Integer] The unique ID number of the job
70
+ # @param phaseId [Integer] The unique ID number of the phase to delete
71
+ # @return [Object]
72
+ def delete_job_phase(companyId, jobId, phaseId) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}"
73
+ delete(path, {}, AvaTax::VERSION) end
74
+
75
+ # Delete a task from a phase
76
+ #
77
+ # ### Security Policies
78
+ #
79
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
80
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
81
+ # Swagger Name: AvaTaxClient
82
+ # @param companyId [Integer] The unique ID number of the company
83
+ # @param jobId [Integer] The unique ID number of the job
84
+ # @param phaseId [Integer] The unique ID number of the phase
85
+ # @param taskId [Integer] The unique ID number of the task to delete
86
+ # @return [Object]
87
+ def delete_job_task(companyId, jobId, phaseId, taskId) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}/tasks/#{taskId}"
88
+ delete(path, {}, AvaTax::VERSION) end
89
+
90
+ # Retrieve a single job
91
+ #
92
+ # Retrieve a single job by its unique ID.
93
+ #
94
+ # A job represents construction or project work that exemption certificates can be associated with. Each
95
+ # job can contain one or more phases, and each phase can contain one or more tasks.
96
+ #
97
+ # You can use the `$include` parameter to fetch the following additional objects for expansion:
98
+ #
99
+ # * phases - Retrieves the list of phases for this job.
100
+ # * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases, so requesting `tasks` will also expand `phases`.
101
+ #
102
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
103
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
104
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
105
+ # certificate storage for this company, call `RequestCertificateSetup`.
106
+ #
107
+ # ### Security Policies
108
+ #
109
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
110
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
111
+ # Swagger Name: AvaTaxClient
112
+ # @param companyId [Integer] The unique ID number of the company
113
+ # @param id [Integer] The unique ID number of the job
114
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * phases - Retrieves the list of phases for this job. * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases, so requesting `tasks` will also expand `phases`.
115
+ # @return [Object]
116
+ def get_job(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/jobs/#{id}"
117
+ get(path, options, AvaTax::VERSION) end
118
+
119
+ # List all jobs for a company
120
+ #
121
+ # List all jobs recorded by a company.
122
+ #
123
+ # A job represents construction or project work that exemption certificates can be associated with. Each
124
+ # job can contain one or more phases, and each phase can contain one or more tasks.
125
+ #
126
+ # You can use the `$include` parameter to fetch the following additional objects for expansion:
127
+ #
128
+ # * phases - Retrieves the list of phases for each job.
129
+ # * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases, so requesting `tasks` will also expand `phases`.
130
+ #
131
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
132
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
133
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
134
+ # certificate storage for this company, call `RequestCertificateSetup`.
135
+ #
136
+ # ### Security Policies
137
+ #
138
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
139
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
140
+ # Swagger Name: AvaTaxClient
141
+ # @param companyId [Integer] The unique ID number of the company
142
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * phases - Retrieves the list of phases for each job. * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases
143
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exposureZone, phases
144
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
145
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
146
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
147
+ # @return [FetchResult]
148
+ def list_jobs(companyId, options={}) path = "/api/v2/companies/#{companyId}/jobs"
149
+ get(path, options, AvaTax::VERSION) end
150
+
151
+ # Update an existing job
152
+ #
153
+ # ### Security Policies
154
+ #
155
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
156
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
157
+ # Swagger Name: AvaTaxClient
158
+ # @param companyId [Integer] The unique ID number of the company
159
+ # @param id [Integer] The unique ID number of the job to update
160
+ # @param model [Object] The updated job data
161
+ # @return [Object]
162
+ def update_job(companyId, id, model) path = "/api/v2/companies/#{companyId}/jobs/#{id}"
163
+ put(path, model, {}, AvaTax::VERSION) end
164
+
165
+ # Update an existing phase on a job
166
+ #
167
+ # ### Security Policies
168
+ #
169
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
170
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
171
+ # Swagger Name: AvaTaxClient
172
+ # @param companyId [Integer] The unique ID number of the company
173
+ # @param jobId [Integer] The unique ID number of the job
174
+ # @param phaseId [Integer] The unique ID number of the phase
175
+ # @param model [Object] The updated phase data
176
+ # @return [Object]
177
+ def update_job_phase(companyId, jobId, phaseId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}"
178
+ put(path, model, {}, AvaTax::VERSION) end
179
+
180
+ # Update an existing task on a phase
181
+ #
182
+ # ### Security Policies
183
+ #
184
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
185
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
186
+ # Swagger Name: AvaTaxClient
187
+ # @param companyId [Integer] The unique ID number of the company
188
+ # @param jobId [Integer] The unique ID number of the job
189
+ # @param phaseId [Integer] The unique ID number of the phase
190
+ # @param taskId [Integer] The unique ID number of the task
191
+ # @param model [Object] The updated task data
192
+ # @return [Object]
193
+ def update_job_task(companyId, jobId, phaseId, taskId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}/tasks/#{taskId}"
194
+ put(path, model, {}, AvaTax::VERSION) end
195
+ end
196
+ end
197
+ end
@@ -5,14 +5,26 @@ module AvaTax
5
5
 
6
6
  # Download an audit log report
7
7
  #
8
- # Downloads the file associated with an audit log report.
9
- # If the report is not yet complete, you will receive a `ReportNotFinished` error.
8
+ # This API downloads the file associated with an audit log report.
9
+ #
10
+ # If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
11
+ # use the `GetAuditLogReport` API.
12
+ #
13
+ # Reports are run on the server. When complete, the report file will be available for download
14
+ # for up to 30 days after completion. To run a report, you should follow these steps:
15
+ #
16
+ # * Begin a report by calling the report's ExportAuditLogs API.
17
+ # * In the result of the ExportAuditLogs API, you receive back a report's `id` value.
18
+ # * Check the status of a report by calling `GetAuditLogReport` and passing in the report's `id` value.
19
+ # * When a report's status is `Completed`, call `DownloadAuditLogReport` to retrieve the file.
20
+ #
21
+ # * We throttle this API. You can only call this API up to 5 times in a minute.
10
22
  #
11
23
  # ### Security Policies
12
24
  #
13
25
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
14
26
  # Swagger Name: AvaTaxClient
15
- # @param id [String] The unique ID of the audit log report
27
+ # @param id [String] The unique ID number of this report
16
28
  # @return [Object]
17
29
  def download_audit_log_report(id) path = "/api/v2/reports/exportauditlogs/#{id}/attachment"
18
30
  get(path, {}, AvaTax::VERSION) end
@@ -47,24 +59,60 @@ module AvaTax
47
59
  #
48
60
  # Begins running an `ExportAuditLogs` report task and returns the identity of the report.
49
61
  #
62
+ # Reports are run on the server. When complete, the report file will be available for download
63
+ # for up to 30 days after completion. To run a report, you should follow these steps:
64
+ #
65
+ # * Begin a report by calling the report's ExportAuditLogs API.
66
+ # * In the result of the ExportAuditLogs API, you receive a report's `id` value.
67
+ # * All reports with `InQueue` status are picked up by the report service and processed in the background.
68
+ # * Reports that are picked up by the report service will have an `InProgress` status.
69
+ # * Reports will be updated to `Completed` status when the report is ready for download.
70
+ # * Check the status of a report by calling `GetAuditLogReport` and passing in the report's `id` value.
71
+ # * When a report's status is `Completed`, call `DownloadAuditLogReport` to retrieve the file.
72
+ #
73
+ # The `ExportAuditLogs` report produces information about audit records within your account.
74
+ #
75
+ # The following `reportType` values are supported:
76
+ # * `audit` - Exports audit records for configuration changes. Requires `reportSubType` to specify the table name.
77
+ # * `audittransactionlogs` - Exports transaction audit logs.
78
+ #
79
+ # When `reportType` is `audit`, the `reportSubType` field supports the following valid table names:
80
+ # `NEXUS`, `USER`, `COMPANY`, `ACCOUNT`, `COMPANYLOCATION`, `ACCOUNTSETTING`, `COMPANYLOCATIONSETTING`,
81
+ # `COMPANYSETTING`, `TAXCODE`, `TAXRULE`, `ADDRESSSERVICECONFIG`, `AUDITADVANCEDRULE`, `COMPANYCONTACT`,
82
+ # `COMPANYLOCATIONPARAMETERDETAIL`, `COMPANYLOCATIONSETTINGCONFIG`, `COMPANYPARAMETERDETAIL`, `COMPANYRETURN`,
83
+ # `COMPANYRETURNSETTING`, `ITEM`, `SERVICE`, `EXEMPTCERT`, `AVACERTSERVICECONFIG`, `JURISDICTIONOVERRIDE`, `COSTCENTER`,
84
+ # `FILINGTASKSTATUSHISTORY`, `COMPANYSTATUSHISTORY`.
85
+ #
86
+ # Set `compression` to `GZIP` to reduce the size of the report file and increase download speed.
87
+ #
50
88
  # ### Security Policies
51
89
  #
52
90
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
53
91
  # Swagger Name: AvaTaxClient
54
- # @param model [Object] Options to filter the audit log export.
92
+ # @param model [Object] Options that may be configured to customize the report.
55
93
  # @return [ReportAuditLogResponseModel[]]
56
94
  def export_audit_logs(model) path = "/api/v2/reports/exportauditlogs"
57
95
  post(path, model, {}, AvaTax::VERSION) end
58
96
 
59
- # Get an audit log report by id
97
+ # Retrieve a single audit log report
60
98
  #
61
- # Retrieves the status and details of an audit log report task.
99
+ # Retrieve a single audit log report by its unique ID number.
100
+ #
101
+ # Reports are run on the server. When complete, the report file will be available for download
102
+ # for up to 30 days after completion. To run a report, you should follow these steps:
103
+ #
104
+ # * Begin a report by calling the report's ExportAuditLogs API.
105
+ # * In the result of the ExportAuditLogs API, you receive back a report's `id` value.
106
+ # * Check the status of a report by calling `GetAuditLogReport` and passing in the report's `id` value.
107
+ # * When a report's status is `Completed`, call `DownloadAuditLogReport` to retrieve the file.
108
+ #
109
+ # This API call returns information about audit log report types.
62
110
  #
63
111
  # ### Security Policies
64
112
  #
65
113
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
66
114
  # Swagger Name: AvaTaxClient
67
- # @param id [String] The unique ID of the audit log report
115
+ # @param id [String] The unique ID number of the report to retrieve
68
116
  # @return [Object]
69
117
  def get_audit_log_report(id) path = "/api/v2/reports/exportauditlogs/#{id}"
70
118
  get(path, {}, AvaTax::VERSION) end
@@ -107,7 +155,7 @@ module AvaTax
107
155
  #
108
156
  # Set `compression` to `GZIP` to reduce the size of the report file and increase download speed.
109
157
  #
110
- # The currently supported reports are: **Document Line**, **Document Line Detail**, **Multitax Line Detail**, **Liability**, **Tax Region**, **AP Document**, **AP Document Detail**, and **Document Line Detail All Taxes**.
158
+ # The currently supported reports are: **Document**, **Document Summary**, **Document Line**, **Document Line Detail**, **Multitax Line Detail**, **Liability**, **Tax Region**, **AP Document**, **AP Document Detail**, and **Document Line Detail All Taxes**.
111
159
  #
112
160
  # ### Security Policies
113
161
  #
@@ -133,6 +181,13 @@ module AvaTax
133
181
  #
134
182
  # This API call returns information about all report types across your entire account.
135
183
  #
184
+ # Audit-log report types (`audit`, `audittransactionlogs`) are not included in this list; retrieve those via the
185
+ # `GetAuditLogReport` / `DownloadAuditLogReport` APIs.
186
+ #
187
+ # Pagination note: when the response includes a non-null `pageKey` (next link), more results may exist and the
188
+ # caller should follow it, even if the current page returned fewer than the requested number of records. This can
189
+ # happen when a `$filter` is applied, because matches are evaluated server-side across backend pages.
190
+ #
136
191
  # ### Security Policies
137
192
  #
138
193
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -141,6 +196,7 @@ module AvaTax
141
196
  # @param pageKey [String] Provide a page key to retrieve the next page of results.
142
197
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
143
198
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
199
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* reportType, parameters, status, size, format, file, createdUser, completedDate
144
200
  # @return [FetchResult]
145
201
  def list_reports(options={}) path = "/api/v2/reports"
146
202
  get(path, options, AvaTax::VERSION) end
@@ -576,7 +576,7 @@ module AvaTax
576
576
  # @param companyCode [String] The company code of the company that recorded this transaction
577
577
  # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
578
578
  # @param include [String] Specifies objects to include in this fetch call
579
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount
579
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exchangeRateCurrencyCode, exchangeRateProvider, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount
580
580
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
581
581
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
582
582
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -37,7 +37,7 @@ module AvaTax
37
37
  # Swagger Name: AvaTaxClient
38
38
  # @param companyId [Integer] The ID number of the company to search
39
39
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of vendors linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
40
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages
40
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
41
41
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
42
42
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
43
43
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -121,7 +121,7 @@ module AvaTax
121
121
  # @param companyId [Integer] The unique ID number of the company that recorded this vendor
122
122
  # @param vendorCode [String] The unique code representing this vendor
123
123
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * vendors - Retrieves the list of vendors linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
124
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages
124
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
125
125
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
126
126
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
127
127
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '26.6.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '26.8.3'.freeze unless defined?(::AvaTax::VERSION)
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: avatax
3
3
  version: !ruby/object:Gem::Version
4
- version: 26.6.0
4
+ version: 26.8.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marcus Vorwaller
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-06-09 00:00:00.000000000 Z
11
+ date: 2026-08-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -134,6 +134,7 @@ files:
134
134
  - lib/avatax/client/compliance.rb
135
135
  - lib/avatax/client/contacts.rb
136
136
  - lib/avatax/client/costcenter.rb
137
+ - lib/avatax/client/currencyroundingrules.rb
137
138
  - lib/avatax/client/customers.rb
138
139
  - lib/avatax/client/datasources.rb
139
140
  - lib/avatax/client/definitions.rb
@@ -153,6 +154,7 @@ files:
153
154
  - lib/avatax/client/glaccount.rb
154
155
  - lib/avatax/client/items.rb
155
156
  - lib/avatax/client/itemsreversesync.rb
157
+ - lib/avatax/client/jobs.rb
156
158
  - lib/avatax/client/jurisdictionoverrides.rb
157
159
  - lib/avatax/client/locations.rb
158
160
  - lib/avatax/client/multidocument.rb