avatax 26.9.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 +4 -4
- data/lib/avatax/client/batches.rb +6 -3
- data/lib/avatax/client/certificates.rb +42 -1
- data/lib/avatax/client/customers.rb +1 -1
- data/lib/avatax/client/customrules.rb +15 -5
- data/lib/avatax/client/definitions.rb +42 -6
- data/lib/avatax/client/econexusthreshold.rb +4 -4
- data/lib/avatax/client/exchangerateproviderconfig.rb +137 -0
- data/lib/avatax/client/items.rb +32 -6
- data/lib/avatax/client/nexus.rb +3 -0
- data/lib/avatax/client/reports.rb +4 -1
- data/lib/avatax/client/transactions.rb +1 -1
- data/lib/avatax/client/vendorcertificates.rb +1 -1
- data/lib/avatax/client/vendors.rb +1 -1
- data/lib/avatax/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 42e1b084f78be2f2d42fe1cb67f292121b2656401b39a2fb74fe4832863355bf
|
|
4
|
+
data.tar.gz: 292916061a0a3421665856333dfca442f9c6b362d716fae430b723b190ce3d6d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 939da9d91efff2ac10725c4354c66a009f2c3a1b91e9e3920bce13c5a627d9a3aad63d35944a6e5596ea9566a731e300e79c4fcc29d940ec121f0a9641896b23
|
|
7
|
+
data.tar.gz: 7669d713c1be5fdc66ede6cd65b6f57cc2c570c40dc0513a90043045d0fb4412d484ea329f645a4dddd962da55b50c75e7505501a363f7dc6dc875f53c7119d5
|
|
@@ -150,9 +150,12 @@ module AvaTax
|
|
|
150
150
|
# required, please use the
|
|
151
151
|
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
|
152
152
|
#
|
|
153
|
-
# Set `skipTransactionValidation` to true to defer transaction type, company code
|
|
154
|
-
# nested model validation until BatchV2 processes each transaction.
|
|
155
|
-
# validation failures are then written to the batch error file without
|
|
153
|
+
# Set `skipTransactionValidation` to true to defer transaction type, company code
|
|
154
|
+
# existence, and nested model validation until BatchV2 processes each transaction.
|
|
155
|
+
# Per-transaction validation failures are then written to the batch error file without
|
|
156
|
+
# blocking upload. Skipping validation only defers those checks; transactions that omit
|
|
157
|
+
# `companyCode` still inherit the company from this URL, exactly as they do when
|
|
158
|
+
# validation runs at upload time.
|
|
156
159
|
#
|
|
157
160
|
# The maximum content length of the request body is limited to 28.6 MB. If this limit
|
|
158
161
|
# is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
|
|
@@ -343,6 +343,47 @@ module AvaTax
|
|
|
343
343
|
def list_custom_fields_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
|
|
344
344
|
get(path, {}, AvaTax::VERSION) end
|
|
345
345
|
|
|
346
|
+
# List the exemption matrix entries for an exposure zone
|
|
347
|
+
#
|
|
348
|
+
# Returns the entries in this company's exemption matrix for one exposure zone.
|
|
349
|
+
#
|
|
350
|
+
# Each entry carries the `timeLength` rule used to work out when a certificate
|
|
351
|
+
# recorded for that exposure zone and exempt reason expires, and the
|
|
352
|
+
# `qualifyingStatement` shown to the customer. See the `timeLength` field
|
|
353
|
+
# description for the meaning of each rule value.
|
|
354
|
+
#
|
|
355
|
+
# `exposureZoneId` is mandatory. Supplying `exemptReasonId` narrows the result to
|
|
356
|
+
# that one exempt reason; omitting it returns every exempt reason configured for
|
|
357
|
+
# the zone. Call `ListCertificateExposureZones` and `ListCertificateExemptReasons`
|
|
358
|
+
# to look up the available ID numbers.
|
|
359
|
+
#
|
|
360
|
+
# An exposure zone with nothing configured returns an empty list rather than a
|
|
361
|
+
# `404`, so "nothing configured" can be told apart from "no expiration rule".
|
|
362
|
+
# Exempt reasons that are disabled, or that denote exposure rather than exemption,
|
|
363
|
+
# are never listed.
|
|
364
|
+
#
|
|
365
|
+
# Results are paginated with `$top` and `$skip`. As with the other exemption
|
|
366
|
+
# certificate query APIs, `$skip` must be a multiple of `$top`.
|
|
367
|
+
#
|
|
368
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
369
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
370
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
371
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
372
|
+
#
|
|
373
|
+
# ### Security Policies
|
|
374
|
+
#
|
|
375
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
376
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
377
|
+
# Swagger Name: AvaTaxClient
|
|
378
|
+
# @param companyId [Integer] The ID number of the company
|
|
379
|
+
# @param exposureZoneId [Integer] Required. The ID number of the exposure zone.
|
|
380
|
+
# @param exemptReasonId [Integer] Optional. The ID number of an exempt reason. Omit to return every exempt reason configured for the exposure zone.
|
|
381
|
+
# @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.
|
|
382
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
383
|
+
# @return [FetchResult]
|
|
384
|
+
def list_exemption_matrix(companyId, options={}) path = "/api/v2/companies/#{companyId}/exemptionmatrix"
|
|
385
|
+
get(path, options, AvaTax::VERSION) end
|
|
386
|
+
|
|
346
387
|
# List local exempt jurisdictions for a given exposure zone and tax code
|
|
347
388
|
#
|
|
348
389
|
# Returns the list of jurisdictions that are valid for a given combination of exposure zone
|
|
@@ -407,7 +448,7 @@ module AvaTax
|
|
|
407
448
|
# Swagger Name: AvaTaxClient
|
|
408
449
|
# @param companyId [Integer] The ID number of the company to search
|
|
409
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
|
|
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
|
|
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
|
|
411
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.
|
|
412
453
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
413
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`.
|
|
@@ -40,7 +40,11 @@ module AvaTax
|
|
|
40
40
|
# The `scope` of an action determines what part of the transaction to apply changes to: `Document`, `MatchedLines`, `NotMatchedLines`, or `AllLines`.
|
|
41
41
|
#
|
|
42
42
|
# When using a rule to adjust taxability,
|
|
43
|
-
# -
|
|
43
|
+
# - Prefer classifying the transaction so Avalara's built-in tax content applies
|
|
44
|
+
# (for example by setting a standard tax code or entity use code with
|
|
45
|
+
# `UpdateField`) before using a `TaxRule*` action to override that content.
|
|
46
|
+
# - To treat a line as nontaxable under Avalara's standard nontaxable code, use an
|
|
47
|
+
# `UpdateField` node to set its tax code to `NT`.
|
|
44
48
|
# - Place the UpdateField early in the rule so it takes effect pre-calculation.
|
|
45
49
|
# - To impact tax details, the MatchTax condition node is required to match on jurisdiction + tax type combinations.
|
|
46
50
|
# - There can only be one MatchTax node per rule, but it can have more than one criteria set.
|
|
@@ -52,7 +56,8 @@ module AvaTax
|
|
|
52
56
|
# - `TaxRuleProductTaxability`: sets an item's taxability and assigns its rate type, so it requires a specific (non-wildcard) `rateTypeCode`.
|
|
53
57
|
# - `TaxRuleRateOverride`: overrides Avalara's tax rate.
|
|
54
58
|
# - `TaxRuleBaseOverride`: changes the tax base as a proportion of the original amount (e.g. `0.5` = 50% taxable).
|
|
55
|
-
# - `TaxRuleExemptEntity`:
|
|
59
|
+
# - `TaxRuleExemptEntity`: after sourcing, overrides whether the matched line is
|
|
60
|
+
# exempt for the jurisdiction and tax type.
|
|
56
61
|
# - Caps and thresholds can be applied with the `TaxRuleProductTaxability` or `TaxRuleRateOverride` actions.
|
|
57
62
|
# - A threshold buckets amounts up to and including the threshold as non-taxable.
|
|
58
63
|
# - A cap limits the taxable amount (per unit by default, multiplied by quantity); amounts above the cap become non-taxable.
|
|
@@ -337,7 +342,7 @@ module AvaTax
|
|
|
337
342
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
338
343
|
# Swagger Name: AvaTaxClient
|
|
339
344
|
# @param companyId [Integer] The ID of the company to query the custom rules for.
|
|
340
|
-
# @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:*
|
|
345
|
+
# @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:* ruleEntity
|
|
341
346
|
# @param taxRuleFilter [String] A simple filter statement to select specific TaxRuleModel records. Applied to the underlying Legacy Tax Rule entities before they are converted into summary records; evaluated before `filter`.
|
|
342
347
|
# @param advancedRuleFilter [String] A simple filter statement to select specific AdvancedRuleExecutionModel records. Applied to the underlying Advanced Rule entities before they are converted into summary records; evaluated before `filter`.
|
|
343
348
|
# @param customRuleFilter [String] A simple filter statement to select specific CustomRuleOutputModel records. Applied to the underlying Custom Rule entities before they are converted into summary records; evaluated before `filter`.
|
|
@@ -391,7 +396,11 @@ module AvaTax
|
|
|
391
396
|
# The `scope` of an action determines what part of the transaction to apply changes to: `Document`, `MatchedLines`, `NotMatchedLines`, or `AllLines`.
|
|
392
397
|
#
|
|
393
398
|
# When using a rule to adjust taxability,
|
|
394
|
-
# -
|
|
399
|
+
# - Prefer classifying the transaction so Avalara's built-in tax content applies
|
|
400
|
+
# (for example by setting a standard tax code or entity use code with
|
|
401
|
+
# `UpdateField`) before using a `TaxRule*` action to override that content.
|
|
402
|
+
# - To treat a line as nontaxable under Avalara's standard nontaxable code, use an
|
|
403
|
+
# `UpdateField` node to set its tax code to `NT`.
|
|
395
404
|
# - Place the UpdateField early in the rule so it takes effect pre-calculation.
|
|
396
405
|
# - To impact tax details, the MatchTax condition node is required to match on jurisdiction + tax type combinations.
|
|
397
406
|
# - There can only be one MatchTax node per rule, but it can have more than one criteria set.
|
|
@@ -403,7 +412,8 @@ module AvaTax
|
|
|
403
412
|
# - `TaxRuleProductTaxability`: sets an item's taxability and assigns its rate type, so it requires a specific (non-wildcard) `rateTypeCode`.
|
|
404
413
|
# - `TaxRuleRateOverride`: overrides Avalara's tax rate.
|
|
405
414
|
# - `TaxRuleBaseOverride`: changes the tax base as a proportion of the original amount (e.g. `0.5` = 50% taxable).
|
|
406
|
-
# - `TaxRuleExemptEntity`:
|
|
415
|
+
# - `TaxRuleExemptEntity`: after sourcing, overrides whether the matched line is
|
|
416
|
+
# exempt for the jurisdiction and tax type.
|
|
407
417
|
# - Caps and thresholds can be applied with the `TaxRuleProductTaxability` or `TaxRuleRateOverride` actions.
|
|
408
418
|
# - A threshold buckets amounts up to and including the threshold as non-taxable.
|
|
409
419
|
# - A cap limits the taxable amount (per unit by default, multiplied by quantity); amounts above the cap become non-taxable.
|
|
@@ -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.
|
|
@@ -529,7 +556,9 @@ module AvaTax
|
|
|
529
556
|
#
|
|
530
557
|
# Returns the full list of all Avalara-supported nexus for all countries and regions.
|
|
531
558
|
#
|
|
532
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus.
|
|
559
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus.
|
|
560
|
+
#
|
|
561
|
+
# The `localNexusTypeId` field can be null. Treat null as `Selected`, the same as the Tax Calculation Service does.
|
|
533
562
|
# Swagger Name: AvaTaxClient
|
|
534
563
|
# @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters
|
|
535
564
|
# @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.
|
|
@@ -566,7 +595,9 @@ module AvaTax
|
|
|
566
595
|
#
|
|
567
596
|
# Returns all Avalara-supported nexus for the specified country.
|
|
568
597
|
#
|
|
569
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
|
|
598
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
|
|
599
|
+
#
|
|
600
|
+
# The `localNexusTypeId` field can be null. Treat null as `Selected`, the same as the Tax Calculation Service does.
|
|
570
601
|
# Swagger Name: AvaTaxClient
|
|
571
602
|
# @param country [String] The country in which you want to fetch the system nexus
|
|
572
603
|
# @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters
|
|
@@ -581,7 +612,9 @@ module AvaTax
|
|
|
581
612
|
#
|
|
582
613
|
# Returns all Avalara-supported nexus for the specified country and region.
|
|
583
614
|
#
|
|
584
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
|
|
615
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
|
|
616
|
+
#
|
|
617
|
+
# The `localNexusTypeId` field can be null. Treat null as `Selected`, the same as the Tax Calculation Service does.
|
|
585
618
|
# Swagger Name: AvaTaxClient
|
|
586
619
|
# @param country [String] The two-character ISO-3166 code for the country.
|
|
587
620
|
# @param region [String] The two or three character region code for the region.
|
|
@@ -620,7 +653,9 @@ module AvaTax
|
|
|
620
653
|
#
|
|
621
654
|
# Returns all Avalara-supported nexus for the specified specified tax type group.
|
|
622
655
|
#
|
|
623
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group.
|
|
656
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group.
|
|
657
|
+
#
|
|
658
|
+
# The `localNexusTypeId` field can be null. Treat null as `Selected`, the same as the Tax Calculation Service does.
|
|
624
659
|
# Swagger Name: AvaTaxClient
|
|
625
660
|
# @param taxTypeGroup [String] The tax type group to fetch the supporting system nexus for.
|
|
626
661
|
# @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters
|
|
@@ -825,10 +860,11 @@ module AvaTax
|
|
|
825
860
|
# This list of parameters is available for use when configuring your transaction.
|
|
826
861
|
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
|
827
862
|
# Swagger Name: AvaTaxClient
|
|
828
|
-
# @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:* attributeSubType, values, valueDescriptions
|
|
863
|
+
# @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:* attributeSubType, values, valueDescriptions, jurisdictionTypeId, jurisdictionCode, jurisdictionName, unitOfBasis, taxSubTypeId
|
|
829
864
|
# @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.
|
|
830
865
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
831
866
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
867
|
+
# @param include [String] A comma separated list of additional data to retrieve, for example "jurisdictionDetail" (case-insensitive). When present, the response includes jurisdictionTypeId, jurisdictionCode, jurisdictionName, unitOfBasis and taxSubTypeId for each result. These fields are not available to $filter/$orderBy.
|
|
832
868
|
# @return [FetchResult]
|
|
833
869
|
def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
|
|
834
870
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -1106,7 +1142,7 @@ module AvaTax
|
|
|
1106
1142
|
#
|
|
1107
1143
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
1108
1144
|
# Swagger Name: AvaTaxClient
|
|
1109
|
-
# @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/)
|
|
1145
|
+
# @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:* hasParameters
|
|
1110
1146
|
# @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.
|
|
1111
1147
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
1112
1148
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
@@ -5,18 +5,18 @@ module AvaTax
|
|
|
5
5
|
|
|
6
6
|
# Retrieve economic nexus threshold statuses for a company
|
|
7
7
|
#
|
|
8
|
-
# Retrieve the economic nexus threshold status for each US
|
|
8
|
+
# Retrieve the economic nexus threshold status for each US region in which activity has been
|
|
9
9
|
# evaluated for this company.
|
|
10
10
|
#
|
|
11
11
|
# Each entry in `states` describes the measurement window used, the sales and transaction
|
|
12
|
-
# thresholds that apply to that
|
|
12
|
+
# thresholds that apply to that region, the company's totals for the window, and whether
|
|
13
13
|
# the threshold has been met.
|
|
14
14
|
#
|
|
15
15
|
# Threshold statuses are evaluated on a recurring schedule rather than at request time.
|
|
16
16
|
# Use `lastRefreshedAt` to determine how current the returned data is; when it is absent
|
|
17
17
|
# from the response, the age of the data is not known.
|
|
18
18
|
#
|
|
19
|
-
# When the optional `region` query parameter is provided, only the matching
|
|
19
|
+
# When the optional `region` query parameter is provided, only the matching region is included
|
|
20
20
|
# in `states`. If no threshold status exists for that company and region, `states` is returned
|
|
21
21
|
# as an empty array with a 200 response.
|
|
22
22
|
#
|
|
@@ -27,7 +27,7 @@ module AvaTax
|
|
|
27
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.
|
|
28
28
|
# Swagger Name: AvaTaxClient
|
|
29
29
|
# @param companyId [Integer] The ID of the company to retrieve threshold statuses for.
|
|
30
|
-
# @param region [String] Optional two-letter US
|
|
30
|
+
# @param region [String] Optional two-letter US region 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.
|
|
31
31
|
# @return [Object]
|
|
32
32
|
def get_eco_nexus_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/econexusthresholds"
|
|
33
33
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -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
|
data/lib/avatax/client/items.rb
CHANGED
|
@@ -116,10 +116,17 @@ module AvaTax
|
|
|
116
116
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
117
117
|
# Swagger Name: AvaTaxClient
|
|
118
118
|
# @param companyId [Integer] The ID of the company that owns this items.
|
|
119
|
+
# @param x-Avalara-Batch-Id [String] Optional. The `X-Avalara-Batch-Id` header (for example: `batchv2-98421`). Ties chunks of one source file together; consumed by downstream services.
|
|
120
|
+
# @param x-Avalara-Is-Last-Chunk [String] Optional. The `X-Avalara-Is-Last-Chunk` header. Accepts the string values `true` or `false`. Marks the final chunk of a file; consumed by downstream services.
|
|
121
|
+
# @param x-Avalara-Tax-Mode [String] Optional. The `X-Avalara-Tax-Mode` header (for example: `HIGH`). Governs downstream ICP tax code classification; consumed by downstream services.
|
|
119
122
|
# @param model [Object] The items you wish to upload.
|
|
120
123
|
# @return [Object]
|
|
121
|
-
def bulk_upload_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/upload"
|
|
122
|
-
|
|
124
|
+
def bulk_upload_items(companyId, model, x_Avalara_Batch_Id="", x_Avalara_Is_Last_Chunk="", x_Avalara_Tax_Mode="") path = "/api/v2/companies/#{companyId}/items/upload"
|
|
125
|
+
headers= Hash.new
|
|
126
|
+
headers["x-Avalara-Batch-Id"]=x_Avalara_Batch_Id;
|
|
127
|
+
headers["x-Avalara-Is-Last-Chunk"]=x_Avalara_Is_Last_Chunk;
|
|
128
|
+
headers["x-Avalara-Tax-Mode"]=x_Avalara_Tax_Mode;
|
|
129
|
+
post(path, model, {}, AvaTax::VERSION, headers) end
|
|
123
130
|
|
|
124
131
|
# Add classifications to an item.
|
|
125
132
|
#
|
|
@@ -215,10 +222,13 @@ module AvaTax
|
|
|
215
222
|
# Swagger Name: AvaTaxClient
|
|
216
223
|
# @param companyId [Integer] The ID of the company that owns this item.
|
|
217
224
|
# @param processRecommendationsSynchronously [Boolean] If true then Indix api will be called synchronously to get tax code recommendations.
|
|
225
|
+
# @param x-Avalara-Tax-Mode [String] Optional. The `X-Avalara-Tax-Mode` header (for example: `HIGH`). Governs downstream ICP tax code classification; consumed by downstream services.
|
|
218
226
|
# @param model [ItemModel[]] The item you wish to create.
|
|
219
227
|
# @return [ItemModel[]]
|
|
220
|
-
def create_items(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/items"
|
|
221
|
-
|
|
228
|
+
def create_items(companyId, model, options={}, x_Avalara_Tax_Mode="") path = "/api/v2/companies/#{companyId}/items"
|
|
229
|
+
headers= Hash.new
|
|
230
|
+
headers["x-Avalara-Tax-Mode"]=x_Avalara_Tax_Mode;
|
|
231
|
+
post(path, model, options, AvaTax::VERSION, headers) end
|
|
222
232
|
|
|
223
233
|
# Create tags for a item
|
|
224
234
|
#
|
|
@@ -699,10 +709,13 @@ module AvaTax
|
|
|
699
709
|
# * 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.
|
|
700
710
|
# Swagger Name: AvaTaxClient
|
|
701
711
|
# @param companyId [Integer] The unique ID of the company.
|
|
712
|
+
# @param x-Avalara-Tax-Mode [String] Optional. The `X-Avalara-Tax-Mode` header (Accepted values:'HIGH', 'MEDIUM', 'LOW'). Governs downstream ICP tax code classification.
|
|
702
713
|
# @param model [ItemTaxcodeRecommendationBatchesInputModel[]] The list of items to analyze for tax code recommendations (maximum 50).
|
|
703
714
|
# @return [ItemTaxcodeRecommendationBatchesOutputModel[]]
|
|
704
|
-
def get_sync_tax_code_recommendations(companyId, model) path = "/api/v2/companies/#{companyId}/$taxcode-recommendations"
|
|
705
|
-
|
|
715
|
+
def get_sync_tax_code_recommendations(companyId, model, x_Avalara_Tax_Mode="") path = "/api/v2/companies/#{companyId}/$taxcode-recommendations"
|
|
716
|
+
headers= Hash.new
|
|
717
|
+
headers["x-Avalara-Tax-Mode"]=x_Avalara_Tax_Mode;
|
|
718
|
+
post(path, model, {}, AvaTax::VERSION, headers) end
|
|
706
719
|
|
|
707
720
|
# Create an HS code classification request.
|
|
708
721
|
#
|
|
@@ -1091,6 +1104,19 @@ module AvaTax
|
|
|
1091
1104
|
def sync_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/sync"
|
|
1092
1105
|
post(path, model, {}, AvaTax::VERSION) end
|
|
1093
1106
|
|
|
1107
|
+
# Update HS Duty Details for an item.
|
|
1108
|
+
#
|
|
1109
|
+
# ### Security Policies
|
|
1110
|
+
#
|
|
1111
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
1112
|
+
# Swagger Name: AvaTaxClient
|
|
1113
|
+
# @param companyId [Integer] The ID of the company for which you want to update HS Duty Details.
|
|
1114
|
+
# @param itemId [Integer] The ID of the item for which you want to update HS Duty Details.
|
|
1115
|
+
# @param model [ItemHSCodeDutyDetailModel[]] The complete HS Code Duty Details body (as returned by fetch-additional-hsdutydetails) to update.
|
|
1116
|
+
# @return [ItemHSCodeDutyDetailModel[]]
|
|
1117
|
+
def update_h_s_code_duty_details(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hsdutydetails"
|
|
1118
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
1119
|
+
|
|
1094
1120
|
# Update an existing image for an item.
|
|
1095
1121
|
#
|
|
1096
1122
|
# This endpoint allows users to update the existing image associated with a specific item by uploading a new image file.
|
data/lib/avatax/client/nexus.rb
CHANGED
|
@@ -157,6 +157,7 @@ module AvaTax
|
|
|
157
157
|
# accountant or lawyer prior to declaring nexus.
|
|
158
158
|
# 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:
|
|
159
159
|
#
|
|
160
|
+
# The `localNexusTypeId` field can be null. Treat null as `Selected`, the same as the Tax Calculation Service does.
|
|
160
161
|
# * Parameters
|
|
161
162
|
#
|
|
162
163
|
# ### Security Policies
|
|
@@ -228,6 +229,7 @@ module AvaTax
|
|
|
228
229
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
|
229
230
|
# 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:
|
|
230
231
|
#
|
|
232
|
+
# The `localNexusTypeId` field can be null. Treat null as `Selected`, the same as the Tax Calculation Service does.
|
|
231
233
|
# * Parameters
|
|
232
234
|
#
|
|
233
235
|
# ### Security Policies
|
|
@@ -311,6 +313,7 @@ module AvaTax
|
|
|
311
313
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
|
312
314
|
# 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:
|
|
313
315
|
#
|
|
316
|
+
# The `localNexusTypeId` field can be null. Treat null as `Selected`, the same as the Tax Calculation Service does.
|
|
314
317
|
# * Parameters
|
|
315
318
|
#
|
|
316
319
|
# ### Security Policies
|
|
@@ -83,6 +83,9 @@ module AvaTax
|
|
|
83
83
|
# `COMPANYRETURNSETTING`, `ITEM`, `SERVICE`, `EXEMPTCERT`, `AVACERTSERVICECONFIG`, `JURISDICTIONOVERRIDE`, `COSTCENTER`,
|
|
84
84
|
# `FILINGTASKSTATUSHISTORY`, `COMPANYSTATUSHISTORY`.
|
|
85
85
|
#
|
|
86
|
+
# Use `reportSubType` = `All` to run the report across all supported tables. When `All` is used it must be
|
|
87
|
+
# the only `reportSubType` and cannot carry filters.
|
|
88
|
+
#
|
|
86
89
|
# Set `compression` to `GZIP` to reduce the size of the report file and increase download speed.
|
|
87
90
|
#
|
|
88
91
|
# ### Security Policies
|
|
@@ -181,7 +184,7 @@ module AvaTax
|
|
|
181
184
|
#
|
|
182
185
|
# This API call returns information about all report types across your entire account.
|
|
183
186
|
#
|
|
184
|
-
# 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
|
|
185
188
|
# `GetAuditLogReport` / `DownloadAuditLogReport` APIs.
|
|
186
189
|
#
|
|
187
190
|
# Pagination note: when the response includes a non-null `pageKey` (next link), more results may exist and the
|
|
@@ -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, exchangeRateProvider, 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, customClearanceFees
|
|
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, 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`.
|
data/lib/avatax/version.rb
CHANGED
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.
|
|
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-
|
|
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
|