avatax 26.10.0 → 26.10.1

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: '099ec35a196f72ddb27c67d1a53b75943acc79b9f850e4ee88b08ffb8c333a07'
4
- data.tar.gz: e7afd978e7876ca949d5e604e84c5df2d38adcd85097ad25bcc8125615153f6a
3
+ metadata.gz: 42e1b084f78be2f2d42fe1cb67f292121b2656401b39a2fb74fe4832863355bf
4
+ data.tar.gz: 292916061a0a3421665856333dfca442f9c6b362d716fae430b723b190ce3d6d
5
5
  SHA512:
6
- metadata.gz: eb0f02dd980361eacf7a571487107527b584274bb856811acba4d08c272bfa27c524a7d4d58880f25f0411f6c2c256d18af0ab1b18673f52dac0c1a52159aea5
7
- data.tar.gz: 9d31fb692a1188c9d630c2228d673274eee914876b4fbbedcce9f4fa19844c3d4b672dff922047fab4eb31f679f1813ff6bb70721a3086167bc9dc6b5e05bc3c
6
+ metadata.gz: 939da9d91efff2ac10725c4354c66a009f2c3a1b91e9e3920bce13c5a627d9a3aad63d35944a6e5596ea9566a731e300e79c4fcc29d940ec121f0a9641896b23
7
+ data.tar.gz: 7669d713c1be5fdc66ede6cd65b6f57cc2c570c40dc0513a90043045d0fb4412d484ea329f645a4dddd962da55b50c75e7505501a363f7dc6dc875f53c7119d5
@@ -448,7 +448,7 @@ module AvaTax
448
448
  # Swagger Name: AvaTaxClient
449
449
  # @param companyId [Integer] The ID number of the company to search
450
450
  # @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
451
- # @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
451
+ # @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:* originalFilename, exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
452
452
  # @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.
453
453
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
454
454
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -297,7 +297,7 @@ module AvaTax
297
297
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
298
298
  # @param customerCode [String] The unique code representing this customer
299
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
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
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:* originalFilename, exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
301
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.
302
302
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
303
303
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -305,6 +305,33 @@ module AvaTax
305
305
  def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
306
306
  get(path, options, AvaTax::VERSION) end
307
307
 
308
+ # Retrieve supported exchange rate providers and their available frequencies
309
+ #
310
+ # Returns one row per (provider, frequency) pair that AvaTax currently offers, so a
311
+ # provider available at more than one frequency appears more than once.
312
+ #
313
+ # Read this list before creating an ExchangeRateProviderConfig: the providerCode and
314
+ # frequency on that request must name a pair returned here. The pair also determines the
315
+ # configuration's currency, which is why baseCurrency is returned but never supplied.
316
+ #
317
+ # Only pairs whose mapping, provider and frequency are all active are listed.
318
+ #
319
+ # Search for specific objects using the criteria in the `$filter` parameter.
320
+ # Paginate your results using the `$top` and `$skip` parameters, and sort them
321
+ # using `$orderBy`.
322
+ #
323
+ # ### Security Policies
324
+ #
325
+ # * 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, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
326
+ # Swagger Name: AvaTaxClient
327
+ # @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/).
328
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
329
+ # @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.
330
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
331
+ # @return [FetchResult]
332
+ def list_exchange_rate_provider_definitions(options={}) path = "/api/v2/definitions/exchangerateproviders"
333
+ get(path, options, AvaTax::VERSION) end
334
+
308
335
  # Retrieve the full list of Avalara-supported filing frequencies.
309
336
  #
310
337
  # Returns the full list of Avalara-supported filing frequencies.
@@ -0,0 +1,137 @@
1
+ module AvaTax
2
+ class Client
3
+ module ExchangeRateProviderConfig
4
+
5
+
6
+ # Create an ExchangeRateProviderConfig object
7
+ #
8
+ # Create an ExchangeRateProviderConfig object for this company.
9
+ #
10
+ # Name the feed with `providerCode` and `frequency`; both must match a pair
11
+ # from `ListExchangeRateProviderDefinitions`. The server derives `currencyCode`.
12
+ #
13
+ # Customer configuration is currently supported for Switzerland (`countryCode: CH`)
14
+ # using provider `SNB` to select between `Daily` and `Monthly` publishing
15
+ # frequencies. `effDate` must be today or a future date (UTC). If `endDate` is
16
+ # omitted, it defaults to `9999-12-31`.
17
+ # System defaults are read-only. Overlapping date ranges for the same currency and country
18
+ # return 400.
19
+ #
20
+ # ### Security Policies
21
+ #
22
+ # * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
23
+ # Swagger Name: AvaTaxClient
24
+ # @param companyId [Integer] The unique ID number of the company that owns this ExchangeRateProviderConfig
25
+ # @param model [Object] The ExchangeRateProviderConfig object you wish to create.
26
+ # @return [Object]
27
+ def create_exchange_rate_provider_config(companyId, model) path = "/api/v2/companies/#{companyId}/exchangerateproviderconfigurations"
28
+ post(path, model, {}, AvaTax::VERSION) end
29
+
30
+ # Delete a single ExchangeRateProviderConfig object
31
+ #
32
+ # Deletes the ExchangeRateProviderConfig object identified by this URL.
33
+ #
34
+ # This operation permanently removes a future configuration record. Deletion is
35
+ # permitted only when the configuration has not yet taken effect (`effDate` is
36
+ # strictly after today). Active, currently effective, or historical configurations
37
+ # cannot be deleted because they may have been referenced during transaction
38
+ # calculation. To end an active configuration, use `PUT` to update the
39
+ # `endDate` instead.
40
+ #
41
+ # Currently, this operation applies only to customer configurations for Switzerland
42
+ # (`CH`) using provider `SNB`. System defaults are read-only.
43
+ #
44
+ # ### Security Policies
45
+ #
46
+ # * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
47
+ # Swagger Name: AvaTaxClient
48
+ # @param companyId [Integer] The unique ID number of the company that owns this ExchangeRateProviderConfig
49
+ # @param id [Integer] The unique ID number of the ExchangeRateProviderConfig object you wish to delete.
50
+ # @return [ErrorDetail[]]
51
+ def delete_exchange_rate_provider_config(companyId, id) path = "/api/v2/companies/#{companyId}/exchangerateproviderconfigurations/#{id}"
52
+ delete(path, {}, AvaTax::VERSION) end
53
+
54
+ # Retrieve a single ExchangeRateProviderConfig
55
+ #
56
+ # Retrieves a single ExchangeRateProviderConfig object defined by this URL.
57
+ #
58
+ # This endpoint returns only a configuration owned by the company in the URL. Inherited
59
+ # system defaults are available through the company List endpoint.
60
+ #
61
+ # An exchange rate provider configuration selects which Exchange Rate Service provider
62
+ # feed and refresh frequency a company uses when converting a given currency, optionally
63
+ # narrowed to a country.
64
+ #
65
+ # ### Security Policies
66
+ #
67
+ # * 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, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
68
+ # Swagger Name: AvaTaxClient
69
+ # @param companyId [Integer] The ID of the company that owns this ExchangeRateProviderConfig object
70
+ # @param id [Integer] The unique ID number referring to this ExchangeRateProviderConfig object
71
+ # @return [Object]
72
+ def get_exchange_rate_provider_config(companyId, id) path = "/api/v2/companies/#{companyId}/exchangerateproviderconfigurations/#{id}"
73
+ get(path, {}, AvaTax::VERSION) end
74
+
75
+ # Retrieve all ExchangeRateProviderConfig objects for this company
76
+ #
77
+ # Lists ExchangeRateProviderConfig objects that apply to this company.
78
+ #
79
+ # The company-scoped list answers "what applies to me": it returns this company's
80
+ # configurations together with inherited system defaults. Expired rows
81
+ # (`endDate` before today) are omitted. Future-dated customer rows are kept.
82
+ # A customer configuration replaces an inherited system default with the same currency and
83
+ # country. Inherited system defaults are read-only. The `isConfigurable` value
84
+ # indicates whether a customer configuration may be created for that country and provider;
85
+ # when it is false or null, an override is not permitted. Transaction-time provider
86
+ # resolution is handled separately by the tax engine.
87
+ # An exchange rate supplied with the transaction takes precedence over Exchange Rate
88
+ # Service lookup and this configuration.
89
+ #
90
+ # Search for specific objects using the criteria in the `$filter` parameter; full
91
+ # documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
92
+ # Paginate your results using the `$top` and `$skip` parameters, and sort them
93
+ # using `$orderBy`.
94
+ #
95
+ # ### Security Policies
96
+ #
97
+ # * 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, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
98
+ # Swagger Name: AvaTaxClient
99
+ # @param companyId [Integer] The ID of the company whose ExchangeRateProviderConfig objects you wish to list.
100
+ # @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:* providerCode, frequency, isConfigurable
101
+ # @param include [String] A comma separated list of additional data to retrieve.
102
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
103
+ # @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.
104
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
105
+ # @return [FetchResult]
106
+ def list_exchange_rate_provider_configs(companyId, options={}) path = "/api/v2/companies/#{companyId}/exchangerateproviderconfigurations"
107
+ get(path, options, AvaTax::VERSION) end
108
+
109
+ # Update an ExchangeRateProviderConfig object
110
+ #
111
+ # Updates the ExchangeRateProviderConfig object at this URL.
112
+ #
113
+ # Only `endDate` may be changed on an existing row. `countryCode`,
114
+ # `effDate`, `providerCode` and `frequency` are immutable once created —
115
+ # end-date the row and create a new one to change any of them — and a PUT must restate
116
+ # them to match the stored row. `endDate` is required and must be today or a future
117
+ # date (UTC).
118
+ #
119
+ # An `endDate` change that creates an overlapping effective date range for the same
120
+ # currency and country returns 400.
121
+ #
122
+ # Currently, this operation applies only to customer configurations for Switzerland
123
+ # (`CH`) using provider `SNB`. System defaults are read-only.
124
+ #
125
+ # ### Security Policies
126
+ #
127
+ # * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
128
+ # Swagger Name: AvaTaxClient
129
+ # @param companyId [Integer] The unique ID number of the company that owns this ExchangeRateProviderConfig object.
130
+ # @param id [Integer] The unique ID number of the ExchangeRateProviderConfig object to replace.
131
+ # @param model [Object] The new ExchangeRateProviderConfig object to store.
132
+ # @return [Object]
133
+ def update_exchange_rate_provider_config(companyId, id, model) path = "/api/v2/companies/#{companyId}/exchangerateproviderconfigurations/#{id}"
134
+ put(path, model, {}, AvaTax::VERSION) end
135
+ end
136
+ end
137
+ end
@@ -184,7 +184,7 @@ module AvaTax
184
184
  #
185
185
  # This API call returns information about all report types across your entire account.
186
186
  #
187
- # Audit-log report types (`audit`, `audittransactionlogs`) are not included in this list; retrieve those via the
187
+ # Audit-log report types (`audit`, `audittransactionlogs`, `auditbatchtransactionlogs`) are not included in this list; retrieve those via the
188
188
  # `GetAuditLogReport` / `DownloadAuditLogReport` APIs.
189
189
  #
190
190
  # Pagination note: when the response includes a non-null `pageKey` (next link), more results may exist and the
@@ -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, jurisdictions, 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, originalFilename, 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, jurisdictions, 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, originalFilename, 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.10.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '26.10.1'.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.10.0
4
+ version: 26.10.1
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-10-13 00:00:00.000000000 Z
11
+ date: 2026-11-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -146,6 +146,7 @@ files:
146
146
  - lib/avatax/client/ecommercetoken.rb
147
147
  - lib/avatax/client/econexusthreshold.rb
148
148
  - lib/avatax/client/errortransactions.rb
149
+ - lib/avatax/client/exchangerateproviderconfig.rb
149
150
  - lib/avatax/client/filingcalendars.rb
150
151
  - lib/avatax/client/filings.rb
151
152
  - lib/avatax/client/firmclientlinkages.rb