Module: AvaTax::Client::Definitions

Included in:
AvaTax::Client
Defined in:
lib/avatax/client/definitions.rb

Instance Method Summary collapse

Instance Method Details

#get_cross_border_code(country, hsCode) ⇒ FetchResult

Lists all parents of an HS Code.

Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings

a list of HS Codes that are the parents and information branches of the HS Code for the given destination country, if lower detail is available.

This API will include information branches if applicable. These do not have HS Codes and cannot be referenced, but can contain information relevant to deciding the correct HS Code.

This API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful when HS Codes can have multiple levels of generic descriptions.

Security Policies

  • This API depends on the following active services:Required (all): AvaTaxGlobal. Swagger Name: AvaTaxClient


26
27
 
# File 'lib/avatax/client/definitions.rb', line 26

def get_cross_border_code(country, hsCode)        path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
get(path, {}, AvaTax::VERSION)      end

#get_login_verifier_by_form(form, options = {}) ⇒ FetchResult

Test whether a form supports online login verification

This API is intended to be useful to identify whether the user should be allowed to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification. Swagger Name: AvaTaxClient



40
41
 
# File 'lib/avatax/client/definitions.rb', line 40

def (form, options={})        path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
get(path, options, AvaTax::VERSION)      end

#list_all_marketplace_locations(options = {}) ⇒ FetchResult

List all market place locations.

List all market place locations. Swagger Name: AvaTaxClient



52
53
 
# File 'lib/avatax/client/definitions.rb', line 52

def list_all_marketplace_locations(options={})        path = "/api/v2/definitions/listallmarketplacelocations"
get(path, options, AvaTax::VERSION)      end

#list_ava_file_forms(options = {}) ⇒ FetchResult

Retrieve the full list of the AvaFile Forms available

This API is deprecated.

Please use the ListTaxForms API.

Returns the full list of Avalara-supported AvaFile Forms This API is intended to be useful to identify all the different AvaFile Forms Swagger Name: AvaTaxClient



69
70
 
# File 'lib/avatax/client/definitions.rb', line 69

def list_ava_file_forms(options={})        path = "/api/v2/definitions/avafileforms"
get(path, options, AvaTax::VERSION)      end

#list_certificate_attributes(options = {}) ⇒ FetchResult

List certificate attributes used by a company

List the certificate attributes defined by a company either specified by the user or the user's default company.

A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a certificate at any time.

If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to check and provision account. Swagger Name: AvaTaxClient



88
89
 
# File 'lib/avatax/client/definitions.rb', line 88

def list_certificate_attributes(options={})        path = "/api/v2/definitions/certificateattributes"
get(path, options, AvaTax::VERSION)      end

#list_certificate_exempt_reasons(options = {}) ⇒ FetchResult

List the certificate exempt reasons defined by a company

List the certificate exempt reasons defined by a company.

An exemption reason defines why a certificate allows a customer to be exempt for purposes of tax calculation.

If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to check and provision account. Swagger Name: AvaTaxClient



106
107
 
# File 'lib/avatax/client/definitions.rb', line 106

def list_certificate_exempt_reasons(options={})        path = "/api/v2/definitions/certificateexemptreasons"
get(path, options, AvaTax::VERSION)      end

#list_certificate_exposure_zones(options = {}) ⇒ FetchResult

List certificate exposure zones used by a company

List the certificate exposure zones defined by a company.

An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing authority or other legal entity to which a certificate may apply.

If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to check and provision account. Swagger Name: AvaTaxClient



124
125
 
# File 'lib/avatax/client/definitions.rb', line 124

def list_certificate_exposure_zones(options={})        path = "/api/v2/definitions/certificateexposurezones"
get(path, options, AvaTax::VERSION)      end

#list_classification_parameters_usage(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.

Returns the full list of Avalara-supported usage of extra parameters for item classification. The list of parameters is available for use with Item Classification. Some parameters are only available for use if you have subscribed to certain features of AvaTax. Swagger Name: AvaTaxClient



138
139
 
# File 'lib/avatax/client/definitions.rb', line 138

def list_classification_parameters_usage(options={})        path = "/api/v2/definitions/classification/parametersusage"
get(path, options, AvaTax::VERSION)      end

#list_communications_service_types(id, options = {}) ⇒ FetchResult

Retrieve the full list of communications service types

Returns full list of service types for a given transaction type ID. Swagger Name: AvaTaxClient



151
152
 
# File 'lib/avatax/client/definitions.rb', line 151

def list_communications_service_types(id, options={})        path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
get(path, options, AvaTax::VERSION)      end

#list_communications_t_s_pairs(options = {}) ⇒ FetchResult

Retrieve the full list of communications transaction/service type pairs

Returns full list of communications transaction/service type pairs which are accepted in communication tax calculation requests. Swagger Name: AvaTaxClient



177
178
 
# File 'lib/avatax/client/definitions.rb', line 177

def list_communications_t_s_pairs(options={})        path = "/api/v2/definitions/communications/tspairs"
get(path, options, AvaTax::VERSION)      end

#list_communications_transaction_types(options = {}) ⇒ FetchResult

Retrieve the full list of communications transactiontypes

Returns full list of communications transaction types which are accepted in communication tax calculation requests. Swagger Name: AvaTaxClient



164
165
 
# File 'lib/avatax/client/definitions.rb', line 164

def list_communications_transaction_types(options={})        path = "/api/v2/definitions/communications/transactiontypes"
get(path, options, AvaTax::VERSION)      end

#list_countries(options = {}) ⇒ FetchResult

List all ISO 3166 countries

Returns a list of all ISO 3166 country codes, and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for a shipping address. Swagger Name: AvaTaxClient



191
192
 
# File 'lib/avatax/client/definitions.rb', line 191

def list_countries(options={})        path = "/api/v2/definitions/countries"
get(path, options, AvaTax::VERSION)      end

#list_cover_letters(options = {}) ⇒ FetchResult

List certificate exposure zones used by a company

List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.

The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates. An invitation allows customers to use CertExpress to upload their exemption certificates directly; this cover letter explains why the invitation was sent.

If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to check and provision account. Swagger Name: AvaTaxClient



210
211
 
# File 'lib/avatax/client/definitions.rb', line 210

def list_cover_letters(options={})        path = "/api/v2/definitions/coverletters"
get(path, options, AvaTax::VERSION)      end

#list_cross_border_codes(country, hsCode, options = {}) ⇒ FetchResult

Lists the next level of HS Codes given a destination country and HS Code prefix.

Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if additional children are available.

HS Code is interchangeable with "tariff code" and definitions are generally unique to a destination country. An HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by Section/Chapter/Heading/Subheading/Classification.

This API is intended to be useful to identify the correct HS Code to use for your item.

Security Policies

  • This API depends on the following active services:Required (all): AvaTaxGlobal. Swagger Name: AvaTaxClient


235
236
 
# File 'lib/avatax/client/definitions.rb', line 235

def list_cross_border_codes(country, hsCode, options={})        path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
get(path, options, AvaTax::VERSION)      end

#list_cross_border_sections ⇒ FetchResult

List top level HS Code Sections.

Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for classifying tariff codes and the items to which they apply. HS Codes are organized by Section/Chapter/Heading/Subheading/Classification.

This API is intended to be useful to identify the top level Sections for further LandedCost HS Code lookups.

Security Policies

  • This API depends on the following active services:Required (all): AvaTaxGlobal. Swagger Name: AvaTaxClient


252
253
 
# File 'lib/avatax/client/definitions.rb', line 252

def list_cross_border_sections()        path = "/api/v2/definitions/crossborder/sections"
get(path, {}, AvaTax::VERSION)      end

#list_currencies(options = {}) ⇒ FetchResult

List all ISO 4217 currencies supported by AvaTax.

Lists all ISO 4217 currencies supported by AvaTax.

This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the currencyCode field in a CreateTransactionModel. Swagger Name: AvaTaxClient



267
268
 
# File 'lib/avatax/client/definitions.rb', line 267

def list_currencies(options={})        path = "/api/v2/definitions/currencies"
get(path, options, AvaTax::VERSION)      end

#list_entity_use_codes(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported entity use codes

Returns the full list of Avalara-supported entity use codes. Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction is occurring. This information is generally used to determine taxability of the product. In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for all transactions that are exempt. Swagger Name: AvaTaxClient



283
284
 
# File 'lib/avatax/client/definitions.rb', line 283

def list_entity_use_codes(options={})        path = "/api/v2/definitions/entityusecodes"
get(path, options, AvaTax::VERSION)      end

#list_filing_frequencies(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported filing frequencies.

Returns the full list of Avalara-supported filing frequencies. This API is intended to be useful to identify all the different filing frequencies that can be used in notices. Swagger Name: AvaTaxClient



296
297
 
# File 'lib/avatax/client/definitions.rb', line 296

def list_filing_frequencies(options={})        path = "/api/v2/definitions/filingfrequencies"
get(path, options, AvaTax::VERSION)      end

#list_item_h_s_code_classification_status ⇒ ItemHSCodeClassificationStatusOutputModel[]

List of all HS code classification statuses that can be assigned to an Item.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient


306
307
 
# File 'lib/avatax/client/definitions.rb', line 306

def list_item_h_s_code_classification_status()        path = "/api/v2/definitions/items/hscode-classification-status"
get(path, {}, AvaTax::VERSION)      end

#list_items_recommendations_status ⇒ ItemTaxCodeRecommendationStatusModel[]

List of all recommendation status which can be assigned to an item

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient


316
317
 
# File 'lib/avatax/client/definitions.rb', line 316

def list_items_recommendations_status()        path = "/api/v2/definitions/items/recommendationstatus"
get(path, {}, AvaTax::VERSION)      end

#list_items_status ⇒ ItemStatusModel[]

List of all possible status which can be assigned to an item

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient


326
327
 
# File 'lib/avatax/client/definitions.rb', line 326

def list_items_status()        path = "/api/v2/definitions/items/status"
get(path, {}, AvaTax::VERSION)      end

#list_jurisdiction_types_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options = {}) ⇒ string[]

List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId

Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId Swagger Name: AvaTaxClient



420
421
 
# File 'lib/avatax/client/definitions.rb', line 420

def list_jurisdiction_types_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={})        path = "/api/v2/definitions/jurisdictionTypes/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
get(path, options, AvaTax::VERSION)      end

#list_jurisdictions(options = {}) ⇒ FetchResult

List jurisdictions based on the filter provided

Returns a list of all Avalara-supported taxing jurisdictions.

This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'

The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API. Swagger Name: AvaTaxClient



343
344
 
# File 'lib/avatax/client/definitions.rb', line 343

def list_jurisdictions(options={})        path = "/api/v2/definitions/jurisdictions"
get(path, options, AvaTax::VERSION)      end

#list_jurisdictions_by_address(options = {}) ⇒ FetchResult

List jurisdictions near a specific address

Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.

This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information. It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby jurisdiction in AvaTax.

The results of this API call can be passed to the CreateJurisdictionOverride API call. Swagger Name: AvaTaxClient



368
369
 
# File 'lib/avatax/client/definitions.rb', line 368

def list_jurisdictions_by_address(options={})        path = "/api/v2/definitions/jurisdictionsnearaddress"
get(path, options, AvaTax::VERSION)      end

#list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options = {}) ⇒ FetchResult

List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId

Returns a list of all Avalara-supported taxing jurisdictions filtered by taxTypeId, taxSubTypeId, country, and rateTypeId.

You can optionally pass region as a query parameter to retrieve jurisdictions that are under that region.

This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'

The jurisdictionType, effectiveDate, and endDate are filterable fields available on the JurisdictionRateTypeTaxTypeMappingModels returned by this API. Swagger Name: AvaTaxClient



392
393
 
# File 'lib/avatax/client/definitions.rb', line 392

def list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={})        path = "/api/v2/definitions/jurisdictions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
get(path, options, AvaTax::VERSION)      end

#list_jurisdictions_hierarchy(options = {}) ⇒ FetchResult

List jurisdictions hierarchy based on the filter provided

Returns a list of all Avalara-supported taxing jurisdictions hirearchy.

This API Lists the hierarchical relationship of jurisdictions for US states, identifying the cities and special taxing jurisdictions (STJs) for a given county within a state.

The rate, salesRate, and useRate fields are not available on the JurisdictionHirearchyModels returned by this API. Swagger Name: AvaTaxClient



408
409
 
# File 'lib/avatax/client/definitions.rb', line 408

def list_jurisdictions_hierarchy(options={})        path = "/api/v2/definitions/jurisdictions/hierarchy"
get(path, options, AvaTax::VERSION)      end

#list_location_questions_by_address(options = {}) ⇒ FetchResult

Retrieve the list of questions that are required for a tax location

Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions. Some tax jurisdictions require that you register or provide additional information to configure each physical place where your company does business. This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly. You can call this API call for any address and obtain information about what questions must be answered in order to properly file tax in that location. Swagger Name: AvaTaxClient



446
447
 
# File 'lib/avatax/client/definitions.rb', line 446

def list_location_questions_by_address(options={})        path = "/api/v2/definitions/locationquestions"
get(path, options, AvaTax::VERSION)      end

#list_login_verifiers(options = {}) ⇒ FetchResult

List all forms where logins can be verified automatically

List all forms where logins can be verified automatically. This API is intended to be useful to identify whether the user should be allowed to automatically verify their login and password. Swagger Name: AvaTaxClient



460
461
 
# File 'lib/avatax/client/definitions.rb', line 460

def (options={})        path = "/api/v2/definitions/filingcalendars/loginverifiers"
get(path, options, AvaTax::VERSION)      end

#list_marketplace_locations(options = {}) ⇒ FetchResult

Retrieve the list of locations for a marketplace.

Retrieves the list of suggested locations for a marketplace. Swagger Name: AvaTaxClient



472
473
 
# File 'lib/avatax/client/definitions.rb', line 472

def list_marketplace_locations(options={})        path = "/api/v2/definitions/marketplacelocations"
get(path, options, AvaTax::VERSION)      end

#list_nexus(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported nexus for all countries and regions.

Returns the full list of all Avalara-supported nexus for all countries and regions.

This API is intended to be useful if your user interface needs to display a selectable list of nexus. Swagger Name: AvaTaxClient



486
487
 
# File 'lib/avatax/client/definitions.rb', line 486

def list_nexus(options={})        path = "/api/v2/definitions/nexus"
get(path, options, AvaTax::VERSION)      end

#list_nexus_by_address(options = {}) ⇒ FetchResult

List all nexus that apply to a specific address.

Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale. In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address where the company does business. The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address. Swagger Name: AvaTaxClient



509
510
 
# File 'lib/avatax/client/definitions.rb', line 509

def list_nexus_by_address(options={})        path = "/api/v2/definitions/nexus/byaddress"
get(path, options, AvaTax::VERSION)      end

#list_nexus_by_country(country, options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported nexus for a country.

Returns all Avalara-supported nexus for the specified country.

This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country. Swagger Name: AvaTaxClient



524
525
 
# File 'lib/avatax/client/definitions.rb', line 524

def list_nexus_by_country(country, options={})        path = "/api/v2/definitions/nexus/#{country}"
get(path, options, AvaTax::VERSION)      end

#list_nexus_by_country_and_region(country, region, options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported nexus for a country and region.

Returns all Avalara-supported nexus for the specified country and region.

This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region. Swagger Name: AvaTaxClient



540
541
 
# File 'lib/avatax/client/definitions.rb', line 540

def list_nexus_by_country_and_region(country, region, options={})        path = "/api/v2/definitions/nexus/#{country}/#{region}"
get(path, options, AvaTax::VERSION)      end

#list_nexus_by_form_code(formCode) ⇒ Object

List nexus related to a tax form

Retrieves a list of nexus related to a tax form.

The concept of Nexus indicates a place where your company has sufficient physical presence and is obligated to collect and remit transaction-based taxes.

When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax in all jurisdictions affected by your transactions.

This API is intended to provide useful information when examining a tax form. If you are about to begin filing a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax form in order to better understand how the form will be filled out.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient


563
564
 
# File 'lib/avatax/client/definitions.rb', line 563

def list_nexus_by_form_code(formCode)        path = "/api/v2/definitions/nexus/byform/#{formCode}"
get(path, {}, AvaTax::VERSION)      end

#list_nexus_by_tax_type_group(taxTypeGroup, options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported nexus for a tax type group.

Returns all Avalara-supported nexus for the specified specified tax type group.

This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group. Swagger Name: AvaTaxClient



578
579
 
# File 'lib/avatax/client/definitions.rb', line 578

def list_nexus_by_tax_type_group(taxTypeGroup, options={})        path = "/api/v2/definitions/nexus/bytaxtypegroup/#{taxTypeGroup}"
get(path, options, AvaTax::VERSION)      end

#list_nexus_tax_type_groups(options = {}) ⇒ FetchResult

Retrieve the full list of nexus tax type groups

Returns the full list of Avalara-supported nexus tax type groups This API is intended to be useful to identify all the different tax sub-types. Swagger Name: AvaTaxClient



591
592
 
# File 'lib/avatax/client/definitions.rb', line 591

def list_nexus_tax_type_groups(options={})        path = "/api/v2/definitions/nexustaxtypegroups"
get(path, options, AvaTax::VERSION)      end

#list_notice_customer_funding_options(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice customer funding options.

Returns the full list of Avalara-supported tax notice customer funding options. This API is intended to be useful to identify all the different notice customer funding options that can be used in notices. Swagger Name: AvaTaxClient



604
605
 
# File 'lib/avatax/client/definitions.rb', line 604

def list_notice_customer_funding_options(options={})        path = "/api/v2/definitions/noticecustomerfundingoptions"
get(path, options, AvaTax::VERSION)      end

#list_notice_customer_types(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice customer types.

Returns the full list of Avalara-supported tax notice customer types. This API is intended to be useful to identify all the different notice customer types. Swagger Name: AvaTaxClient



617
618
 
# File 'lib/avatax/client/definitions.rb', line 617

def list_notice_customer_types(options={})        path = "/api/v2/definitions/noticecustomertypes"
get(path, options, AvaTax::VERSION)      end

#list_notice_filingtypes(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice filing types.

Returns the full list of Avalara-supported tax notice filing types. This API is intended to be useful to identify all the different notice filing types that can be used in notices. Swagger Name: AvaTaxClient



630
631
 
# File 'lib/avatax/client/definitions.rb', line 630

def list_notice_filingtypes(options={})        path = "/api/v2/definitions/noticefilingtypes"
get(path, options, AvaTax::VERSION)      end

#list_notice_priorities(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice priorities.

Returns the full list of Avalara-supported tax notice priorities. This API is intended to be useful to identify all the different notice priorities that can be used in notices. Swagger Name: AvaTaxClient



643
644
 
# File 'lib/avatax/client/definitions.rb', line 643

def list_notice_priorities(options={})        path = "/api/v2/definitions/noticepriorities"
get(path, options, AvaTax::VERSION)      end

#list_notice_reasons(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice reasons.

Returns the full list of Avalara-supported tax notice reasons. This API is intended to be useful to identify all the different tax notice reasons. Swagger Name: AvaTaxClient



656
657
 
# File 'lib/avatax/client/definitions.rb', line 656

def list_notice_reasons(options={})        path = "/api/v2/definitions/noticereasons"
get(path, options, AvaTax::VERSION)      end

#list_notice_responsibilities(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice responsibility ids

Returns the full list of Avalara-supported tax notice responsibility ids This API is intended to be useful to identify all the different tax notice responsibilities. Swagger Name: AvaTaxClient



669
670
 
# File 'lib/avatax/client/definitions.rb', line 669

def list_notice_responsibilities(options={})        path = "/api/v2/definitions/noticeresponsibilities"
get(path, options, AvaTax::VERSION)      end

#list_notice_root_causes(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice root causes

Returns the full list of Avalara-supported tax notice root causes This API is intended to be useful to identify all the different tax notice root causes. Swagger Name: AvaTaxClient



682
683
 
# File 'lib/avatax/client/definitions.rb', line 682

def list_notice_root_causes(options={})        path = "/api/v2/definitions/noticerootcauses"
get(path, options, AvaTax::VERSION)      end

#list_notice_statuses(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice statuses.

Returns the full list of Avalara-supported tax notice statuses. This API is intended to be useful to identify all the different tax notice statuses. Swagger Name: AvaTaxClient



695
696
 
# File 'lib/avatax/client/definitions.rb', line 695

def list_notice_statuses(options={})        path = "/api/v2/definitions/noticestatuses"
get(path, options, AvaTax::VERSION)      end

#list_notice_types(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax notice types.

Returns the full list of Avalara-supported tax notice types. This API is intended to be useful to identify all the different notice types that can be used in notices. Swagger Name: AvaTaxClient



708
709
 
# File 'lib/avatax/client/definitions.rb', line 708

def list_notice_types(options={})        path = "/api/v2/definitions/noticetypes"
get(path, options, AvaTax::VERSION)      end

#list_parameters(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported extra parameters for creating transactions.

Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. This list of parameters is available for use when configuring your transaction. Some parameters are only available for use if you have subscribed to certain features of AvaTax. Swagger Name: AvaTaxClient



722
723
 
# File 'lib/avatax/client/definitions.rb', line 722

def list_parameters(options={})        path = "/api/v2/definitions/parameters"
get(path, options, AvaTax::VERSION)      end

#list_parameters_by_account(accountId, options = {}) ⇒ FetchResult

Retrieve the list of Avalara-supported parameters based on account subscriptions.

Returns the list of Avalara-supported parameters based on account subscriptions. Swagger Name: AvaTaxClient



735
736
 
# File 'lib/avatax/client/definitions.rb', line 735

def (accountId, options={})        path = "/api/v2/definitions/accounts/#{accountId}/parameters"
get(path, options, AvaTax::VERSION)      end

#list_parameters_by_item(companyCode, itemCode, options = {}) ⇒ FetchResult

Retrieve the parameters by companyCode and itemCode.

Returns the list of parameters based on the company's service types and the item code. Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section. Ignores nexus for the AvaAlcohol service type.

NOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:

  • Replace '/' with '_-ava2f-_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
  • Replace '+' with '_-ava2b-_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
  • Replace '?' with '_-ava3f-_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
  • Replace '%' with '_-ava25-_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
  • Replace '#' with '_-ava23-_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'

For Item Code other than the five given above below two should also be used

  • Replace ''' with '_-ava27-_' For example: 'Item'Code' becomes 'Item_-ava27-_Code'
  • Replace '"' with '_-ava22-_' For example: 'Item"Code' becomes 'Item_-ava22-_Code'

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient


766
767
 
# File 'lib/avatax/client/definitions.rb', line 766

def list_parameters_by_item(companyCode, itemCode, options={})        path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
get(path, options, AvaTax::VERSION)      end

#list_parameters_usage(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.

Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call. This list of parameters is available for use when configuring your transaction. Some parameters are only available for use if you have subscribed to certain features of AvaTax. Swagger Name: AvaTaxClient



780
781
 
# File 'lib/avatax/client/definitions.rb', line 780

def list_parameters_usage(options={})        path = "/api/v2/definitions/parametersusage"
get(path, options, AvaTax::VERSION)      end

#list_permissions(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported permissions

Returns the full list of Avalara-supported permission types. This API is intended to be useful to identify the capabilities of a particular user logon. Swagger Name: AvaTaxClient



791
792
 
# File 'lib/avatax/client/definitions.rb', line 791

def list_permissions(options={})        path = "/api/v2/definitions/permissions"
get(path, options, AvaTax::VERSION)      end

#list_postal_codes(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported postal codes.

Retrieves the list of Avalara-supported postal codes. Swagger Name: AvaTaxClient



804
805
 
# File 'lib/avatax/client/definitions.rb', line 804

def list_postal_codes(options={})        path = "/api/v2/definitions/postalcodes"
get(path, options, AvaTax::VERSION)      end

#list_preferred_programs(options = {}) ⇒ FetchResult

List all customs duty programs recognized by AvaTax

List all preferred customs duty programs recognized by AvaTax.

A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents. An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring countries.

To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your preferred program. Next, set the parameter AvaTax.LC.PreferredProgram in your CreateTransaction call to the code of the program. Swagger Name: AvaTaxClient



824
825
 
# File 'lib/avatax/client/definitions.rb', line 824

def list_preferred_programs(options={})        path = "/api/v2/definitions/preferredprograms"
get(path, options, AvaTax::VERSION)      end

#list_product_classification_systems(options = {}) ⇒ FetchResult

List all available product classification systems.

List all available product classification systems.

Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. More than one tax authority might use the same product classification system, but they might charge different tax rates for products. Swagger Name: AvaTaxClient



840
841
 
# File 'lib/avatax/client/definitions.rb', line 840

def list_product_classification_systems(options={})        path = "/api/v2/definitions/productclassificationsystems"
get(path, options, AvaTax::VERSION)      end

#list_product_classification_systems_by_company(companyCode, options = {}) ⇒ FetchResult

List all product classification systems available to a company based on its nexus.

Lists all product classification systems available to a company based on its nexus.

Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. More than one tax authority might use the same product classification system, but they might charge different tax rates for products.

NOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:

  • Replace '/' with '_-ava2f-_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
  • Replace '+' with '_-ava2b-_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
  • Replace '?' with '_-ava3f-_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
  • Replace '%' with '_-ava25-_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
  • Replace '#' with '_-ava23-_' For example: 'Company#Code' becomes 'Company_-ava23-_Code' Swagger Name: AvaTaxClient


865
866
 
# File 'lib/avatax/client/definitions.rb', line 865

def list_product_classification_systems_by_company(companyCode, options={})        path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
get(path, options, AvaTax::VERSION)      end

#list_rate_types_by_country(country, options = {}) ⇒ FetchResult

Retrieve the full list of rate types for each country

Returns the full list of Avalara-supported rate type file types This API is intended to be useful to identify all the different rate types. Swagger Name: AvaTaxClient



879
880
 
# File 'lib/avatax/client/definitions.rb', line 879

def list_rate_types_by_country(country, options={})        path = "/api/v2/definitions/countries/#{country}/ratetypes"
get(path, options, AvaTax::VERSION)      end

#list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options = {}) ⇒ FetchResult

Retrieve the list of rate types by country, TaxType and by TaxSubType

Returns the list of Avalara-supported rate type file types This API is intended to be useful to identify all the different rate types. Swagger Name: AvaTaxClient



895
896
 
# File 'lib/avatax/client/definitions.rb', line 895

def list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options={})        path = "/api/v2/definitions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/ratetypes"
get(path, options, AvaTax::VERSION)      end

#list_regions(options = {}) ⇒ FetchResult

List all ISO 3166 regions

Returns a list of all ISO 3166 region codes and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region within the country for a shipping addresses. Swagger Name: AvaTaxClient



909
910
 
# File 'lib/avatax/client/definitions.rb', line 909

def list_regions(options={})        path = "/api/v2/definitions/regions"
get(path, options, AvaTax::VERSION)      end

#list_regions_by_country(country, options = {}) ⇒ FetchResult

List all ISO 3166 regions for a country

Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region within the country for a shipping addresses. Swagger Name: AvaTaxClient



924
925
 
# File 'lib/avatax/client/definitions.rb', line 924

def list_regions_by_country(country, options={})        path = "/api/v2/definitions/countries/#{country}/regions"
get(path, options, AvaTax::VERSION)      end

#list_regions_by_country_and_tax_type_and_tax_sub_type_and_rate_type(companyId, country, taxTypeId, taxSubTypeId, rateTypeId, jurisdictionTypeId, options = {}) ⇒ FetchResult

Retrieve the list of applicable regions by country tax type, tax sub type, and rate type for a given JurisdictionTypeId

Returns a list of all ISO 3166 region codes for a specific country code and their US English friendly names. This API is intended to be used as a way to provide a dropdown box in your website to allow customers to select a region within the country for shipping addresses. Swagger Name: AvaTaxClient



943
944
 
# File 'lib/avatax/client/definitions.rb', line 943

def list_regions_by_country_and_tax_type_and_tax_sub_type_and_rate_type(companyId, country, taxTypeId, taxSubTypeId, rateTypeId, jurisdictionTypeId, options={})        path = "/api/v2/definitions/companies/#{companyId}/countries/#{country}/regions/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/rateTypeId/#{rateTypeId}/jurisdictionTypeId/#{jurisdictionTypeId}"
get(path, options, AvaTax::VERSION)      end

#list_returns_parameters_usage(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported usage of parameters used for returns.

Returns the full list of Avalara-supported usage of extra parameters for the returns. This list of parameters is available for use with Returns. Some parameters are only available for use if you have subscribed to certain features of AvaTax. Swagger Name: AvaTaxClient



957
958
 
# File 'lib/avatax/client/definitions.rb', line 957

def list_returns_parameters_usage(options={})        path = "/api/v2/definitions/returns/parametersusage"
get(path, options, AvaTax::VERSION)      end

#list_security_roles(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported permissions

Returns the full list of Avalara-supported permission types. This API is intended to be useful when designing a user interface for selecting the security role of a user account. Some security roles are restricted for Avalara internal use. Swagger Name: AvaTaxClient



971
972
 
# File 'lib/avatax/client/definitions.rb', line 971

def list_security_roles(options={})        path = "/api/v2/definitions/securityroles"
get(path, options, AvaTax::VERSION)      end

#list_subscription_types(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported subscription types

Returns the full list of Avalara-supported subscription types. This API is intended to be useful for identifying which features you have added to your account. You may always contact Avalara's sales department for information on available products or services. You cannot change your subscriptions directly through the API. Swagger Name: AvaTaxClient



986
987
 
# File 'lib/avatax/client/definitions.rb', line 986

def list_subscription_types(options={})        path = "/api/v2/definitions/subscriptiontypes"
get(path, options, AvaTax::VERSION)      end

#list_tags(options = {}) ⇒ FetchResult

Retrieve the list all tags supported by avalara

Retrieves the list of suggested locations for a marketplace. Swagger Name: AvaTaxClient



998
999
 
# File 'lib/avatax/client/definitions.rb', line 998

def list_tags(options={})        path = "/api/v2/definitions/tags"
get(path, options, AvaTax::VERSION)      end

#list_tax_authorities(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax authorities.

Returns the full list of Avalara-supported tax authorities. This API is intended to be useful to identify all the different authorities that receive tax. Swagger Name: AvaTaxClient



1011
1012
 
# File 'lib/avatax/client/definitions.rb', line 1011

def list_tax_authorities(options={})        path = "/api/v2/definitions/taxauthorities"
get(path, options, AvaTax::VERSION)      end

#list_tax_authority_forms(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported forms for each tax authority.

Returns the full list of Avalara-supported forms for each tax authority. This list represents tax forms that Avalara recognizes. Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically based on the customer's AvaTax data. Swagger Name: AvaTaxClient



1026
1027
 
# File 'lib/avatax/client/definitions.rb', line 1026

def list_tax_authority_forms(options={})        path = "/api/v2/definitions/taxauthorityforms"
get(path, options, AvaTax::VERSION)      end

#list_tax_authority_types(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax authority types.

Returns the full list of Avalara-supported tax authority types. This API is intended to be useful to identify all the different authority types. Swagger Name: AvaTaxClient



1039
1040
 
# File 'lib/avatax/client/definitions.rb', line 1039

def list_tax_authority_types(options={})        path = "/api/v2/definitions/taxauthoritytypes"
get(path, options, AvaTax::VERSION)      end

#list_tax_code_types(options = {}) ⇒ Object

Retrieve the full list of Avalara-supported tax code types.

Returns the full list of recognized tax code types. A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode. This API is intended to be useful for broadly searching for tax codes by tax code type. Swagger Name: AvaTaxClient



1071
1072
 
# File 'lib/avatax/client/definitions.rb', line 1071

def list_tax_code_types(options={})        path = "/api/v2/definitions/taxcodetypes"
get(path, options, AvaTax::VERSION)      end

#list_tax_codes(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported tax codes.

Retrieves the list of Avalara-supported system tax codes. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient


1059
1060
 
# File 'lib/avatax/client/definitions.rb', line 1059

def list_tax_codes(options={})        path = "/api/v2/definitions/taxcodes"
get(path, options, AvaTax::VERSION)      end

#list_tax_forms(options = {}) ⇒ FetchResult

Retrieve the full list of the Tax Forms available

Returns the full list of Avalara-supported Tax Forms This API is intended to be useful to identify all the different Tax Forms Swagger Name: AvaTaxClient



1084
1085
 
# File 'lib/avatax/client/definitions.rb', line 1084

def list_tax_forms(options={})        path = "/api/v2/definitions/taxforms"
get(path, options, AvaTax::VERSION)      end

#list_tax_sub_types(options = {}) ⇒ FetchResult

Retrieve the full list of tax sub types

Returns the full list of Avalara-supported tax sub-types This API is intended to be useful to identify all the different tax sub-types. Swagger Name: AvaTaxClient



1097
1098
 
# File 'lib/avatax/client/definitions.rb', line 1097

def list_tax_sub_types(options={})        path = "/api/v2/definitions/taxsubtypes"
get(path, options, AvaTax::VERSION)      end

#list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options = {}) ⇒ FetchResult

Retrieve the full list of tax sub types by Country and TaxType

Returns the full list of Avalara-supported tax sub-types This API is intended to be useful to identify all the different tax sub-types for given country and TaxType. Swagger Name: AvaTaxClient



1113
1114
 
# File 'lib/avatax/client/definitions.rb', line 1113

def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={})        path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
get(path, options, AvaTax::VERSION)      end

#list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options = {}) ⇒ FetchResult

Retrieve the full list of tax sub types by jurisdiction code and region

Returns the full list of Avalara-supported tax sub-types by jurisdiction and region This API is intended to be useful to identify all the different tax sub-types. Swagger Name: AvaTaxClient



1128
1129
 
# File 'lib/avatax/client/definitions.rb', line 1128

def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={})        path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
get(path, options, AvaTax::VERSION)      end

#list_tax_type_groups(options = {}) ⇒ FetchResult

Retrieve the full list of tax type groups

Returns the full list of Avalara-supported tax type groups This API is intended to be useful to identify all the different tax type groups. Swagger Name: AvaTaxClient



1141
1142
 
# File 'lib/avatax/client/definitions.rb', line 1141

def list_tax_type_groups(options={})        path = "/api/v2/definitions/taxtypegroups"
get(path, options, AvaTax::VERSION)      end

#list_tax_types_by_nexus_and_country(country, options = {}) ⇒ FetchResult

Retrieve the list of applicable TaxTypes

Retrieves the list of applicable TaxTypes based on Nexus of the company. Swagger Name: AvaTaxClient



1154
1155
 
# File 'lib/avatax/client/definitions.rb', line 1154

def list_tax_types_by_nexus_and_country(country, options={})        path = "/api/v2/definitions/taxtypes/countries/#{country}"
get(path, options, AvaTax::VERSION)      end

#list_unit_of_basis_by_country_and_tax_type_and_tax_sub_type_and_rate_type(country, taxTypeId, taxSubTypeId, options = {}) ⇒ FetchResult

Retrieve the list of applicable UnitOfBasis

Retrieves the list of applicable UnitOfBasis Swagger Name: AvaTaxClient



1169
1170
 
# File 'lib/avatax/client/definitions.rb', line 1169

def list_unit_of_basis_by_country_and_tax_type_and_tax_sub_type_and_rate_type(country, taxTypeId, taxSubTypeId, options={})        path = "/api/v2/definitions/unitofbasis/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
get(path, options, AvaTax::VERSION)      end

#list_unit_of_measurement(options = {}) ⇒ FetchResult

List all defined units of measurement

List all units of measurement systems defined by Avalara.

A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others. Swagger Name: AvaTaxClient



1183
1184
 
# File 'lib/avatax/client/definitions.rb', line 1183

def list_unit_of_measurement(options={})        path = "/api/v2/definitions/unitofmeasurements"
get(path, options, AvaTax::VERSION)      end