avatax 20.1.0 → 20.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +180 -116
  3. data/lib/avatax/client/addresses.rb +34 -34
  4. data/lib/avatax/client/advancedrules.rb +33 -142
  5. data/lib/avatax/client/avafileforms.rb +37 -37
  6. data/lib/avatax/client/batches.rb +122 -122
  7. data/lib/avatax/client/certexpressinvites.rb +70 -70
  8. data/lib/avatax/client/certificates.rb +313 -313
  9. data/lib/avatax/client/companies.rb +234 -232
  10. data/lib/avatax/client/compliance.rb +2 -2
  11. data/lib/avatax/client/contacts.rb +58 -58
  12. data/lib/avatax/client/customers.rb +279 -279
  13. data/lib/avatax/client/datasources.rb +51 -51
  14. data/lib/avatax/client/definitions.rb +448 -435
  15. data/lib/avatax/client/distancethresholds.rb +74 -74
  16. data/lib/avatax/client/filingcalendars.rb +10 -498
  17. data/lib/avatax/client/filings.rb +13 -13
  18. data/lib/avatax/client/firmclientlinkages.rb +54 -54
  19. data/lib/avatax/client/free.rb +73 -73
  20. data/lib/avatax/client/fundingrequests.rb +32 -32
  21. data/lib/avatax/client/items.rb +284 -284
  22. data/lib/avatax/client/jurisdictionoverrides.rb +70 -70
  23. data/lib/avatax/client/locations.rb +87 -84
  24. data/lib/avatax/client/multidocument.rb +294 -234
  25. data/lib/avatax/client/nexus.rb +283 -143
  26. data/lib/avatax/client/notifications.rb +48 -48
  27. data/lib/avatax/client/provisioning.rb +29 -29
  28. data/lib/avatax/client/registrar.rb +122 -122
  29. data/lib/avatax/client/reports.rb +63 -63
  30. data/lib/avatax/client/settings.rb +108 -108
  31. data/lib/avatax/client/subscriptions.rb +35 -35
  32. data/lib/avatax/client/taxcodes.rb +72 -72
  33. data/lib/avatax/client/taxcontent.rb +106 -106
  34. data/lib/avatax/client/taxrules.rb +122 -122
  35. data/lib/avatax/client/transactions.rb +654 -639
  36. data/lib/avatax/client/upcs.rb +63 -63
  37. data/lib/avatax/client/users.rb +121 -121
  38. data/lib/avatax/client/utilities.rb +34 -34
  39. data/lib/avatax/connection.rb +1 -1
  40. data/lib/avatax/request.rb +2 -0
  41. data/lib/avatax/version.rb +1 -1
  42. metadata +3 -3
@@ -5,93 +5,93 @@ module AvaTax
5
5
 
6
6
  # Create and store new datasources for the respective companies.
7
7
  #
8
- # Create one or more datasource objects.
9
- #
10
- # ### Security Policies
11
- #
12
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
8
+ # Create one or more datasource objects.
9
+ #
10
+ # ### Security Policies
11
+ #
12
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
13
13
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
14
- # @param companyId [Integer] The id of the company you which to create the datasources
15
- # @param model [DataSourceModel[]]
14
+ # @param companyId [Integer] The id of the company you which to create the datasources
15
+ # @param model [DataSourceModel[]]
16
16
  # @return [DataSourceModel[]]
17
17
  def create_data_sources(companyId, model) path = "/api/v2/companies/#{companyId}/datasources"
18
18
  post(path, model) end
19
19
 
20
20
  # Delete a datasource by datasource id for a company.
21
21
  #
22
- # Marks the existing datasource for a company as deleted.
23
- #
24
- # ### Security Policies
25
- #
26
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
22
+ # Marks the existing datasource for a company as deleted.
23
+ #
24
+ # ### Security Policies
25
+ #
26
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
27
27
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
28
- # @param companyId [Integer] The id of the company the datasource belongs to.
29
- # @param id [Integer] The id of the datasource you wish to delete.
28
+ # @param companyId [Integer] The id of the company the datasource belongs to.
29
+ # @param id [Integer] The id of the datasource you wish to delete.
30
30
  # @return [ErrorDetail[]]
31
31
  def delete_data_source(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
32
32
  delete(path) end
33
33
 
34
34
  # Get data source by data source id
35
35
  #
36
- # Retrieve the data source by its unique ID number.
37
- #
38
- # ### Security Policies
39
- #
40
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
36
+ # Retrieve the data source by its unique ID number.
37
+ #
38
+ # ### Security Policies
39
+ #
40
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
41
41
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
42
- # @param companyId [Integer]
43
- # @param id [Integer] data source id
42
+ # @param companyId [Integer]
43
+ # @param id [Integer] data source id
44
44
  # @return [Object]
45
45
  def get_data_source_by_id(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
46
46
  get(path) end
47
47
 
48
48
  # Retrieve all datasources for this company
49
49
  #
50
- # Gets multiple datasource objects for a given company.
51
- #
52
- # ### Security Policies
53
- #
54
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
50
+ # Gets multiple datasource objects for a given company.
51
+ #
52
+ # ### Security Policies
53
+ #
54
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
55
55
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
56
- # @param companyId [Integer] The id of the company you wish to retrieve the datasources.
57
- # @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:* isEnabled, isSynced, isAuthorized
58
- # @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.
59
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
60
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
56
+ # @param companyId [Integer] The id of the company you wish to retrieve the datasources.
57
+ # @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:* isEnabled, isSynced, isAuthorized, name, externalState
58
+ # @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.
59
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
60
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
61
61
  # @return [FetchResult]
62
62
  def list_data_sources(companyId, options={}) path = "/api/v2/companies/#{companyId}/datasources"
63
63
  get(path, options) end
64
64
 
65
65
  # Retrieve all datasources
66
66
  #
67
- # Get multiple datasource objects across all companies.
68
- #
69
- # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
70
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
71
- #
72
- # ### Security Policies
73
- #
74
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
67
+ # Get multiple datasource objects across all companies.
68
+ #
69
+ # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
70
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
71
+ #
72
+ # ### Security Policies
73
+ #
74
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
75
75
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
76
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* isEnabled, isSynced, isAuthorized
77
- # @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.
78
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
79
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
76
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState
77
+ # @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.
78
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
79
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
80
80
  # @return [FetchResult]
81
81
  def query_data_sources(options={}) path = "/api/v2/datasources"
82
82
  get(path, options) end
83
83
 
84
84
  # Update a datasource identified by id for a company
85
85
  #
86
- # Updates a datasource for a company.
87
- #
88
- # ### Security Policies
89
- #
90
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
86
+ # Updates a datasource for a company.
87
+ #
88
+ # ### Security Policies
89
+ #
90
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
91
91
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
92
- # @param companyId [Integer] The id of the company the datasource belongs to.
93
- # @param id [Integer] The id of the datasource you wish to delete.
94
- # @param model [Object]
92
+ # @param companyId [Integer] The id of the company the datasource belongs to.
93
+ # @param id [Integer] The id of the datasource you wish to delete.
94
+ # @param model [Object]
95
95
  # @return [Object]
96
96
  def update_data_source(companyId, id, model) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
97
97
  put(path, model) end
@@ -5,103 +5,103 @@ module AvaTax
5
5
 
6
6
  # Lists all parents of an HS Code.
7
7
  #
8
- # Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings
9
- #
10
- # a list of HS Codes that are the parents and information branches of the HS Code for the given
11
- # destination country, if lower detail is available.
12
- #
13
- # This API will include information branches if applicable. These do not have HS Codes and cannot be referenced,
14
- # but can contain information relevant to deciding the correct HS Code.
15
- #
16
- # This API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful
17
- # when HS Codes can have multiple levels of generic descriptions.
18
- #
19
- # ### Security Policies
20
- #
8
+ # Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings
9
+ #
10
+ # a list of HS Codes that are the parents and information branches of the HS Code for the given
11
+ # destination country, if lower detail is available.
12
+ #
13
+ # This API will include information branches if applicable. These do not have HS Codes and cannot be referenced,
14
+ # but can contain information relevant to deciding the correct HS Code.
15
+ #
16
+ # This API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful
17
+ # when HS Codes can have multiple levels of generic descriptions.
18
+ #
19
+ # ### Security Policies
20
+ #
21
21
  # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
22
- # @param country [String] The name or code of the destination country.
23
- # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
22
+ # @param country [String] The name or code of the destination country.
23
+ # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
24
24
  # @return [FetchResult]
25
25
  def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
26
26
  get(path) end
27
27
 
28
28
  # Test whether a form supports online login verification
29
29
  #
30
- # This API is intended to be useful to identify whether the user should be allowed
30
+ # This API is intended to be useful to identify whether the user should be allowed
31
31
  # to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.
32
- # @param form [String] The name of the form you would like to verify. This is the tax form code
33
- # @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
34
- # @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.
35
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
36
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
32
+ # @param form [String] The name of the form you would like to verify. This is the tax form code
33
+ # @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
34
+ # @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.
35
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
36
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
37
37
  # @return [FetchResult]
38
38
  def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
39
39
  get(path, options) end
40
40
 
41
41
  # Retrieve the full list of the AvaFile Forms available
42
42
  #
43
- # This API is deprecated.
44
- #
45
- # Please use the ListTaxForms API.
46
- #
47
- # Returns the full list of Avalara-supported AvaFile Forms
43
+ # This API is deprecated.
44
+ #
45
+ # Please use the ListTaxForms API.
46
+ #
47
+ # Returns the full list of Avalara-supported AvaFile Forms
48
48
  # This API is intended to be useful to identify all the different AvaFile Forms
49
- # @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:* outletTypeId
50
- # @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.
51
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
52
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
49
+ # @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:* outletTypeId
50
+ # @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.
51
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
52
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
53
53
  # @return [FetchResult]
54
54
  def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
55
55
  get(path, options) end
56
56
 
57
57
  # List certificate attributes used by a company
58
58
  #
59
- # List the certificate attributes defined by a company either specified by the user or the user's default company.
60
- #
61
- # A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a
62
- # certificate at any time.
63
- #
64
- # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
59
+ # List the certificate attributes defined by a company either specified by the user or the user's default company.
60
+ #
61
+ # A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a
62
+ # certificate at any time.
63
+ #
64
+ # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
65
65
  # check and provision account.
66
- # @param companyid [Integer] Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company.
67
- # @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/).
68
- # @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.
69
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
70
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
66
+ # @param companyid [Integer] Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company.
67
+ # @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/).
68
+ # @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.
69
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
70
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
71
71
  # @return [FetchResult]
72
72
  def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
73
73
  get(path, options) end
74
74
 
75
75
  # List the certificate exempt reasons defined by a company
76
76
  #
77
- # List the certificate exempt reasons defined by a company.
78
- #
79
- # An exemption reason defines why a certificate allows a customer to be exempt
80
- # for purposes of tax calculation.
81
- #
82
- # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
77
+ # List the certificate exempt reasons defined by a company.
78
+ #
79
+ # An exemption reason defines why a certificate allows a customer to be exempt
80
+ # for purposes of tax calculation.
81
+ #
82
+ # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
83
83
  # check and provision account.
84
- # @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/).
85
- # @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.
86
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
87
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
84
+ # @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/).
85
+ # @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.
86
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
87
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
88
88
  # @return [FetchResult]
89
89
  def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
90
90
  get(path, options) end
91
91
 
92
92
  # List certificate exposure zones used by a company
93
93
  #
94
- # List the certificate exposure zones defined by a company.
95
- #
96
- # An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing
97
- # authority or other legal entity to which a certificate may apply.
98
- #
99
- # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
94
+ # List the certificate exposure zones defined by a company.
95
+ #
96
+ # An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing
97
+ # authority or other legal entity to which a certificate may apply.
98
+ #
99
+ # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
100
100
  # check and provision account.
101
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, companyId, name, tag, description, created, modified, region, country
102
- # @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.
103
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
104
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
101
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, companyId, name, tag, description, created, modified, region, country
102
+ # @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.
103
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
104
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
105
105
  # @return [FetchResult]
106
106
  def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
107
107
  get(path, options) end
@@ -109,105 +109,105 @@ module AvaTax
109
109
  # Retrieve the full list of communications service types
110
110
  #
111
111
  # Returns full list of service types for a given transaction type ID.
112
- # @param id [Integer] The transaction type ID to examine
113
- # @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:* requiredParameters
114
- # @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.
115
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
116
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
112
+ # @param id [Integer] The transaction type ID to examine
113
+ # @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:* requiredParameters
114
+ # @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.
115
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
116
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
117
117
  # @return [FetchResult]
118
118
  def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
119
119
  get(path, options) end
120
120
 
121
121
  # Retrieve the full list of communications transactiontypes
122
122
  #
123
- # Returns full list of communications transaction types which
123
+ # Returns full list of communications transaction types which
124
124
  # are accepted in communication tax calculation requests.
125
- # @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/).
126
- # @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.
127
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
128
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
125
+ # @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/).
126
+ # @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.
127
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
128
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
129
129
  # @return [FetchResult]
130
130
  def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
131
131
  get(path, options) end
132
132
 
133
133
  # Retrieve the full list of communications transaction/service type pairs
134
134
  #
135
- # Returns full list of communications transaction/service type pairs which
135
+ # Returns full list of communications transaction/service type pairs which
136
136
  # are accepted in communication tax calculation requests.
137
- # @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:* requiredParameters
138
- # @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.
139
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
140
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
137
+ # @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:* requiredParameters
138
+ # @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.
139
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
140
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
141
141
  # @return [FetchResult]
142
142
  def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
143
143
  get(path, options) end
144
144
 
145
145
  # List all ISO 3166 countries
146
146
  #
147
- # Returns a list of all ISO 3166 country codes, and their US English friendly names.
148
- # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
147
+ # Returns a list of all ISO 3166 country codes, and their US English friendly names.
148
+ # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
149
149
  # a shipping address.
150
- # @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:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion
151
- # @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.
152
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
153
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
150
+ # @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:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion
151
+ # @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.
152
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
153
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
154
154
  # @return [FetchResult]
155
155
  def list_countries(options={}) path = "/api/v2/definitions/countries"
156
156
  get(path, options) end
157
157
 
158
158
  # List certificate exposure zones used by a company
159
159
  #
160
- # List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
161
- #
162
- # The CoverLetter model represents a message sent along with an invitation to use CertExpress to
163
- # upload certificates. An invitation allows customers to use CertExpress to upload their exemption
164
- # certificates directly; this cover letter explains why the invitation was sent.
165
- #
166
- # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
160
+ # List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
161
+ #
162
+ # The CoverLetter model represents a message sent along with an invitation to use CertExpress to
163
+ # upload certificates. An invitation allows customers to use CertExpress to upload their exemption
164
+ # certificates directly; this cover letter explains why the invitation was sent.
165
+ #
166
+ # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
167
167
  # check and provision account.
168
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version
169
- # @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.
170
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
171
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
168
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version
169
+ # @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.
170
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
171
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
172
172
  # @return [FetchResult]
173
173
  def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
174
174
  get(path, options) end
175
175
 
176
176
  # Lists the next level of HS Codes given a destination country and HS Code prefix.
177
177
  #
178
- # Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if
179
- # additional children are available.
180
- #
181
- # HS Code is interchangeable with "tariff code" and definitions are generally unique to a destination country.
182
- # An HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by
183
- # Section/Chapter/Heading/Subheading/Classification.
184
- #
185
- # This API is intended to be useful to identify the correct HS Code to use for your item.
186
- #
187
- # ### Security Policies
188
- #
178
+ # Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if
179
+ # additional children are available.
180
+ #
181
+ # HS Code is interchangeable with "tariff code" and definitions are generally unique to a destination country.
182
+ # An HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by
183
+ # Section/Chapter/Heading/Subheading/Classification.
184
+ #
185
+ # This API is intended to be useful to identify the correct HS Code to use for your item.
186
+ #
187
+ # ### Security Policies
188
+ #
189
189
  # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
190
- # @param country [String] The name or code of the destination country.
191
- # @param hsCode [String] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
192
- # @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:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength
193
- # @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.
194
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
195
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
190
+ # @param country [String] The name or code of the destination country.
191
+ # @param hsCode [String] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
192
+ # @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:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength
193
+ # @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.
194
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
195
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
196
196
  # @return [FetchResult]
197
197
  def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
198
198
  get(path, options) end
199
199
 
200
200
  # List top level HS Code Sections.
201
201
  #
202
- # Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for
203
- # classifying tariff codes and the items to which they apply. HS Codes are organized
204
- # by Section/Chapter/Heading/Subheading/Classification.
205
- #
206
- # This API is intended to be useful to identify the top level Sections for
207
- # further LandedCost HS Code lookups.
208
- #
209
- # ### Security Policies
210
- #
202
+ # Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for
203
+ # classifying tariff codes and the items to which they apply. HS Codes are organized
204
+ # by Section/Chapter/Heading/Subheading/Classification.
205
+ #
206
+ # This API is intended to be useful to identify the top level Sections for
207
+ # further LandedCost HS Code lookups.
208
+ #
209
+ # ### Security Policies
210
+ #
211
211
  # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
212
212
  # @return [FetchResult]
213
213
  def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
@@ -215,119 +215,119 @@ module AvaTax
215
215
 
216
216
  # List all ISO 4217 currencies supported by AvaTax.
217
217
  #
218
- # Lists all ISO 4217 currencies supported by AvaTax.
219
- #
220
- # 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
218
+ # Lists all ISO 4217 currencies supported by AvaTax.
219
+ #
220
+ # 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
221
221
  # `currencyCode` field in a `CreateTransactionModel`.
222
- # @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/).
223
- # @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.
224
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
225
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
222
+ # @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/).
223
+ # @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.
224
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
225
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
226
226
  # @return [FetchResult]
227
227
  def list_currencies(options={}) path = "/api/v2/definitions/currencies"
228
228
  get(path, options) end
229
229
 
230
230
  # Retrieve the full list of Avalara-supported entity use codes
231
231
  #
232
- # Returns the full list of Avalara-supported entity use codes.
233
- # Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction
234
- # is occurring. This information is generally used to determine taxability of the product.
235
- # In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
232
+ # Returns the full list of Avalara-supported entity use codes.
233
+ # Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction
234
+ # is occurring. This information is generally used to determine taxability of the product.
235
+ # In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
236
236
  # all transactions that are exempt.
237
- # @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:* validCountries
238
- # @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.
239
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
240
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
237
+ # @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:* validCountries
238
+ # @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.
239
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
240
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
241
241
  # @return [FetchResult]
242
242
  def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
243
243
  get(path, options) end
244
244
 
245
245
  # Retrieve the full list of Avalara-supported filing frequencies.
246
246
  #
247
- # Returns the full list of Avalara-supported filing frequencies.
247
+ # Returns the full list of Avalara-supported filing frequencies.
248
248
  # This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
249
- # @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/).
250
- # @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.
251
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
252
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
249
+ # @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/).
250
+ # @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.
251
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
252
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
253
253
  # @return [FetchResult]
254
254
  def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
255
255
  get(path, options) end
256
256
 
257
257
  # List jurisdictions based on the filter provided
258
258
  #
259
- # Returns a list of all Avalara-supported taxing jurisdictions.
260
- #
261
- # This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
262
- # SQL-like query for fetching only the ones you concerned about. For example: effectiveDate &gt; '2016-01-01'
263
- #
259
+ # Returns a list of all Avalara-supported taxing jurisdictions.
260
+ #
261
+ # This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
262
+ # SQL-like query for fetching only the ones you concerned about. For example: effectiveDate &gt; '2016-01-01'
263
+ #
264
264
  # The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
265
- # @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:* rate, salesRate, signatureCode, useRate
266
- # @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.
267
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
268
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
265
+ # @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:* rate, salesRate, signatureCode, useRate
266
+ # @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.
267
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
268
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
269
269
  # @return [FetchResult]
270
270
  def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
271
271
  get(path, options) end
272
272
 
273
273
  # List jurisdictions near a specific address
274
274
  #
275
- # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
276
- #
277
- # This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.
278
- # It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
279
- # jurisdiction in AvaTax.
280
- #
275
+ # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
276
+ #
277
+ # This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.
278
+ # It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
279
+ # jurisdiction in AvaTax.
280
+ #
281
281
  # The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
282
- # @param line1 [String] The first address line portion of this address.
283
- # @param line2 [String] The second address line portion of this address.
284
- # @param line3 [String] The third address line portion of this address.
285
- # @param city [String] The city portion of this address.
286
- # @param region [String] The region, state, or province code portion of this address.
287
- # @param postalCode [String] The postal code or zip code portion of this address.
288
- # @param country [String] The two-character ISO-3166 code of the country portion of this address.
289
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* country, Jurisdictions
290
- # @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.
291
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
292
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
282
+ # @param line1 [String] The first address line portion of this address.
283
+ # @param line2 [String] The second address line portion of this address.
284
+ # @param line3 [String] The third address line portion of this address.
285
+ # @param city [String] The city portion of this address.
286
+ # @param region [String] The region, state, or province code portion of this address.
287
+ # @param postalCode [String] The postal code or zip code portion of this address.
288
+ # @param country [String] The two-character ISO-3166 code of the country portion of this address.
289
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* country, Jurisdictions
290
+ # @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.
291
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
292
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
293
293
  # @return [FetchResult]
294
294
  def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
295
295
  get(path, options) end
296
296
 
297
297
  # Retrieve the list of questions that are required for a tax location
298
298
  #
299
- # Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
300
- # Some tax jurisdictions require that you register or provide additional information to configure each physical place where
301
- # your company does business.
302
- # This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.
303
- # You can call this API call for any address and obtain information about what questions must be answered in order to properly
299
+ # Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
300
+ # Some tax jurisdictions require that you register or provide additional information to configure each physical place where
301
+ # your company does business.
302
+ # This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.
303
+ # You can call this API call for any address and obtain information about what questions must be answered in order to properly
304
304
  # file tax in that location.
305
- # @param line1 [String] The first line of this location's address.
306
- # @param line2 [String] The second line of this location's address.
307
- # @param line3 [String] The third line of this location's address.
308
- # @param city [String] The city part of this location's address.
309
- # @param region [String] The region, state, or province part of this location's address.
310
- # @param postalCode [String] The postal code of this location's address.
311
- # @param country [String] The country part of this location's address.
312
- # @param latitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
313
- # @param longitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
314
- # @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/).
315
- # @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.
316
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
317
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
305
+ # @param line1 [String] The first line of this location's address.
306
+ # @param line2 [String] The second line of this location's address.
307
+ # @param line3 [String] The third line of this location's address.
308
+ # @param city [String] The city part of this location's address.
309
+ # @param region [String] The region, state, or province part of this location's address.
310
+ # @param postalCode [String] The postal code of this location's address.
311
+ # @param country [String] The country part of this location's address.
312
+ # @param latitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
313
+ # @param longitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
314
+ # @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/).
315
+ # @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.
316
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
317
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
318
318
  # @return [FetchResult]
319
319
  def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
320
320
  get(path, options) end
321
321
 
322
322
  # List all forms where logins can be verified automatically
323
323
  #
324
- # List all forms where logins can be verified automatically.
325
- # This API is intended to be useful to identify whether the user should be allowed
324
+ # List all forms where logins can be verified automatically.
325
+ # This API is intended to be useful to identify whether the user should be allowed
326
326
  # to automatically verify their login and password.
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/).<br />*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
328
- # @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.
329
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
330
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
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/).<br />*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
328
+ # @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.
329
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
330
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
331
331
  # @return [FetchResult]
332
332
  def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
333
333
  get(path, options) end
@@ -335,256 +335,269 @@ module AvaTax
335
335
  # Retrieve the list of locations for a marketplace.
336
336
  #
337
337
  # Retrieves the list of suggested locations for a marketplace.
338
- # @param marketplaceId [String] MarketplaceId of a marketplace
339
- # @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.
340
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
341
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
338
+ # @param marketplaceId [String] MarketplaceId of a marketplace
339
+ # @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.
340
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
341
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
342
342
  # @return [FetchResult]
343
343
  def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
344
344
  get(path, options) end
345
345
 
346
346
  # Retrieve the full list of Avalara-supported nexus for all countries and regions.
347
347
  #
348
- # Returns the full list of all Avalara-supported nexus for all countries and regions.
349
- #
348
+ # Returns the full list of all Avalara-supported nexus for all countries and regions.
349
+ #
350
350
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
351
- # @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, taxAuthorityId
352
- # @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.
353
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
354
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
351
+ # @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, taxAuthorityId, taxName, parameters
352
+ # @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.
353
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
354
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
355
355
  # @return [FetchResult]
356
356
  def list_nexus(options={}) path = "/api/v2/definitions/nexus"
357
357
  get(path, options) end
358
358
 
359
359
  # List all nexus that apply to a specific address.
360
360
  #
361
- # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
362
- # This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.
363
- # In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address
364
- # where the company does business.
361
+ # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
362
+ # This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.
363
+ # In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address
364
+ # where the company does business.
365
365
  # The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address.
366
- # @param line1 [String] The first address line portion of this address.
367
- # @param line2 [String] The first address line portion of this address.
368
- # @param line3 [String] The first address line portion of this address.
369
- # @param city [String] The city portion of this address.
370
- # @param region [String] Name or ISO 3166 code identifying the region portion of the address. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
371
- # @param postalCode [String] The postal code or zip code portion of this address.
372
- # @param country [String] Name or ISO 3166 code identifying the country portion of this address. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
373
- # @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, taxAuthorityId
374
- # @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.
375
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
376
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
366
+ # @param line1 [String] The first address line portion of this address.
367
+ # @param line2 [String] The first address line portion of this address.
368
+ # @param line3 [String] The first address line portion of this address.
369
+ # @param city [String] The city portion of this address.
370
+ # @param region [String] Name or ISO 3166 code identifying the region portion of the address. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
371
+ # @param postalCode [String] The postal code or zip code portion of this address.
372
+ # @param country [String] Name or ISO 3166 code identifying the country portion of this address. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
373
+ # @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, taxAuthorityId, taxName, parameters
374
+ # @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.
375
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
376
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
377
377
  # @return [FetchResult]
378
378
  def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
379
379
  get(path, options) end
380
380
 
381
381
  # Retrieve the full list of Avalara-supported nexus for a country.
382
382
  #
383
- # Returns all Avalara-supported nexus for the specified country.
384
- #
383
+ # Returns all Avalara-supported nexus for the specified country.
384
+ #
385
385
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
386
- # @param country [String] The country in which you want to fetch the system nexus
387
- # @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, taxAuthorityId
388
- # @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.
389
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
390
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
386
+ # @param country [String] The country in which you want to fetch the system nexus
387
+ # @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, taxAuthorityId, taxName, parameters
388
+ # @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.
389
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
390
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
391
391
  # @return [FetchResult]
392
392
  def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
393
393
  get(path, options) end
394
394
 
395
395
  # Retrieve the full list of Avalara-supported nexus for a country and region.
396
396
  #
397
- # Returns all Avalara-supported nexus for the specified country and region.
398
- #
397
+ # Returns all Avalara-supported nexus for the specified country and region.
398
+ #
399
399
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
400
- # @param country [String] The two-character ISO-3166 code for the country.
401
- # @param region [String] The two or three character region code for the region.
402
- # @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, taxAuthorityId
403
- # @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.
404
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
405
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
400
+ # @param country [String] The two-character ISO-3166 code for the country.
401
+ # @param region [String] The two or three character region code for the region.
402
+ # @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, taxAuthorityId, taxName, parameters
403
+ # @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.
404
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
405
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
406
406
  # @return [FetchResult]
407
407
  def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
408
408
  get(path, options) end
409
409
 
410
410
  # List nexus related to a tax form
411
411
  #
412
- # Retrieves a list of nexus related to a tax form.
413
- #
414
- # The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated
415
- # to collect and remit transaction-based taxes.
416
- #
417
- # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
418
- # in all jurisdictions affected by your transactions.
419
- #
420
- # This API is intended to provide useful information when examining a tax form. If you are about to begin filing
421
- # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
422
- # form in order to better understand how the form will be filled out.
423
- #
424
- # ### Security Policies
425
- #
412
+ # Retrieves a list of nexus related to a tax form.
413
+ #
414
+ # The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated
415
+ # to collect and remit transaction-based taxes.
416
+ #
417
+ # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
418
+ # in all jurisdictions affected by your transactions.
419
+ #
420
+ # This API is intended to provide useful information when examining a tax form. If you are about to begin filing
421
+ # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
422
+ # form in order to better understand how the form will be filled out.
423
+ #
424
+ # ### Security Policies
425
+ #
426
426
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
427
- # @param formCode [String] The form code that we are looking up the nexus for
427
+ # @param formCode [String] The form code that we are looking up the nexus for
428
428
  # @return [Object]
429
429
  def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
430
430
  get(path) end
431
431
 
432
432
  # Retrieve the full list of nexus tax type groups
433
433
  #
434
- # Returns the full list of Avalara-supported nexus tax type groups
434
+ # Returns the full list of Avalara-supported nexus tax type groups
435
435
  # This API is intended to be useful to identify all the different tax sub-types.
436
- # @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn
437
- # @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.
438
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
439
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
436
+ # @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn
437
+ # @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.
438
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
439
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
440
440
  # @return [FetchResult]
441
441
  def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
442
442
  get(path, options) end
443
443
 
444
444
  # Retrieve the full list of Avalara-supported tax notice customer funding options.
445
445
  #
446
- # Returns the full list of Avalara-supported tax notice customer funding options.
446
+ # Returns the full list of Avalara-supported tax notice customer funding options.
447
447
  # This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
448
- # @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:* activeFlag, sortOrder
449
- # @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.
450
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
451
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
448
+ # @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:* activeFlag, sortOrder
449
+ # @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.
450
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
451
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
452
452
  # @return [FetchResult]
453
453
  def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
454
454
  get(path, options) end
455
455
 
456
456
  # Retrieve the full list of Avalara-supported tax notice customer types.
457
457
  #
458
- # Returns the full list of Avalara-supported tax notice customer types.
458
+ # Returns the full list of Avalara-supported tax notice customer types.
459
459
  # This API is intended to be useful to identify all the different notice customer types.
460
- # @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:* activeFlag, sortOrder
461
- # @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.
462
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
463
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
460
+ # @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:* activeFlag, sortOrder
461
+ # @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.
462
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
463
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
464
464
  # @return [FetchResult]
465
465
  def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
466
466
  get(path, options) end
467
467
 
468
468
  # Retrieve the full list of Avalara-supported tax notice filing types.
469
469
  #
470
- # Returns the full list of Avalara-supported tax notice filing types.
470
+ # Returns the full list of Avalara-supported tax notice filing types.
471
471
  # This API is intended to be useful to identify all the different notice filing types that can be used in notices.
472
- # @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:* description, activeFlag, sortOrder
473
- # @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.
474
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
475
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
472
+ # @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:* description, activeFlag, sortOrder
473
+ # @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.
474
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
475
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
476
476
  # @return [FetchResult]
477
477
  def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
478
478
  get(path, options) end
479
479
 
480
480
  # Retrieve the full list of Avalara-supported tax notice priorities.
481
481
  #
482
- # Returns the full list of Avalara-supported tax notice priorities.
482
+ # Returns the full list of Avalara-supported tax notice priorities.
483
483
  # This API is intended to be useful to identify all the different notice priorities that can be used in notices.
484
- # @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:* activeFlag, sortOrder
485
- # @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.
486
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
487
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
484
+ # @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:* activeFlag, sortOrder
485
+ # @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.
486
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
487
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
488
488
  # @return [FetchResult]
489
489
  def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
490
490
  get(path, options) end
491
491
 
492
492
  # Retrieve the full list of Avalara-supported tax notice reasons.
493
493
  #
494
- # Returns the full list of Avalara-supported tax notice reasons.
494
+ # Returns the full list of Avalara-supported tax notice reasons.
495
495
  # This API is intended to be useful to identify all the different tax notice reasons.
496
- # @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:* description, activeFlag, sortOrder
497
- # @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.
498
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
499
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
496
+ # @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:* description, activeFlag, sortOrder
497
+ # @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.
498
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
499
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
500
500
  # @return [FetchResult]
501
501
  def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
502
502
  get(path, options) end
503
503
 
504
504
  # Retrieve the full list of Avalara-supported tax notice responsibility ids
505
505
  #
506
- # Returns the full list of Avalara-supported tax notice responsibility ids
506
+ # Returns the full list of Avalara-supported tax notice responsibility ids
507
507
  # This API is intended to be useful to identify all the different tax notice responsibilities.
508
- # @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:* sortOrder
509
- # @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.
510
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
511
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
508
+ # @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:* sortOrder
509
+ # @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.
510
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
511
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
512
512
  # @return [FetchResult]
513
513
  def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
514
514
  get(path, options) end
515
515
 
516
516
  # Retrieve the full list of Avalara-supported tax notice root causes
517
517
  #
518
- # Returns the full list of Avalara-supported tax notice root causes
518
+ # Returns the full list of Avalara-supported tax notice root causes
519
519
  # This API is intended to be useful to identify all the different tax notice root causes.
520
- # @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:* sortOrder
521
- # @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.
522
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
523
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
520
+ # @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:* sortOrder
521
+ # @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.
522
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
523
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
524
524
  # @return [FetchResult]
525
525
  def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
526
526
  get(path, options) end
527
527
 
528
528
  # Retrieve the full list of Avalara-supported tax notice statuses.
529
529
  #
530
- # Returns the full list of Avalara-supported tax notice statuses.
530
+ # Returns the full list of Avalara-supported tax notice statuses.
531
531
  # This API is intended to be useful to identify all the different tax notice statuses.
532
- # @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:* isOpen, sortOrder
533
- # @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.
534
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
535
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
532
+ # @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:* isOpen, sortOrder
533
+ # @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.
534
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
535
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
536
536
  # @return [FetchResult]
537
537
  def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
538
538
  get(path, options) end
539
539
 
540
540
  # Retrieve the full list of Avalara-supported tax notice types.
541
541
  #
542
- # Returns the full list of Avalara-supported tax notice types.
542
+ # Returns the full list of Avalara-supported tax notice types.
543
543
  # This API is intended to be useful to identify all the different notice types that can be used in notices.
544
- # @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:* activeFlag, sortOrder
545
- # @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.
546
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
547
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
544
+ # @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:* activeFlag, sortOrder
545
+ # @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.
546
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
547
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
548
548
  # @return [FetchResult]
549
549
  def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
550
550
  get(path, options) end
551
551
 
552
552
  # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
553
553
  #
554
- # Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.
555
- # This list of parameters is available for use when configuring your transaction.
554
+ # Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.
555
+ # This list of parameters is available for use when configuring your transaction.
556
556
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
557
- # @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:* serviceTypes, regularExpression, values
558
- # @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.
559
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
560
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
557
+ # @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:* serviceTypes, regularExpression, values
558
+ # @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.
559
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
560
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
561
561
  # @return [FetchResult]
562
562
  def list_parameters(options={}) path = "/api/v2/definitions/parameters"
563
563
  get(path, options) end
564
564
 
565
565
  # Retrieve the parameters by companyCode and itemCode.
566
566
  #
567
- # Returns the list of parameters based on the company country and state jurisdiction and the item code.
568
- #
569
- # ### Security Policies
570
- #
567
+ # Returns the list of parameters based on the company country and state jurisdiction and the item code.
568
+ #
569
+ # ### Security Policies
570
+ #
571
571
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
572
- # @param companyCode [String] Company code.
573
- # @param itemCode [String] Item code.
574
- # @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:* serviceTypes, regularExpression, values
575
- # @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.
576
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
577
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
572
+ # @param companyCode [String] Company code.
573
+ # @param itemCode [String] Item code.
574
+ # @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:* serviceTypes, regularExpression, values
575
+ # @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.
576
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
577
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
578
578
  # @return [FetchResult]
579
579
  def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
580
580
  get(path, options) end
581
581
 
582
+ # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
583
+ #
584
+ # Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call.
585
+ # This list of parameters is available for use when configuring your transaction.
586
+ # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
587
+ # @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:* values
588
+ # @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.
589
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
590
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
591
+ # @return [FetchResult]
592
+ def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
593
+ get(path, options) end
594
+
582
595
  # Retrieve the full list of Avalara-supported permissions
583
596
  #
584
- # Returns the full list of Avalara-supported permission types.
597
+ # Returns the full list of Avalara-supported permission types.
585
598
  # This API is intended to be useful to identify the capabilities of a particular user logon.
586
- # @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.
587
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
599
+ # @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.
600
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
588
601
  # @return [FetchResult]
589
602
  def list_permissions(options={}) path = "/api/v2/definitions/permissions"
590
603
  get(path, options) end
@@ -592,254 +605,254 @@ module AvaTax
592
605
  # Retrieve the full list of Avalara-supported postal codes.
593
606
  #
594
607
  # Retrieves the list of Avalara-supported postal codes.
595
- # @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/).
596
- # @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.
597
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
598
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
608
+ # @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/).
609
+ # @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.
610
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
611
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
599
612
  # @return [FetchResult]
600
613
  def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
601
614
  get(path, options) end
602
615
 
603
616
  # List all customs duty programs recognized by AvaTax
604
617
  #
605
- # List all preferred customs duty programs recognized by AvaTax.
606
- #
607
- # A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.
608
- # An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring
609
- # countries.
610
- #
611
- # To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your
612
- # preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
618
+ # List all preferred customs duty programs recognized by AvaTax.
619
+ #
620
+ # A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.
621
+ # An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring
622
+ # countries.
623
+ #
624
+ # To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your
625
+ # preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
613
626
  # the program.
614
- # @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:* effectiveDate, endDate
615
- # @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.
616
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
617
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
627
+ # @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:* effectiveDate, endDate
628
+ # @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.
629
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
630
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
618
631
  # @return [FetchResult]
619
632
  def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
620
633
  get(path, options) end
621
634
 
622
635
  # List all available product classification systems.
623
636
  #
624
- # List all available product classification systems.
625
- #
626
- # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
637
+ # List all available product classification systems.
638
+ #
639
+ # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
627
640
  # More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
628
- # @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:* countries
629
- # @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.
630
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
631
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
641
+ # @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:* countries
642
+ # @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.
643
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
644
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
632
645
  # @return [FetchResult]
633
646
  def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
634
647
  get(path, options) end
635
648
 
636
649
  # List all product classification systems available to a company based on its nexus.
637
650
  #
638
- # Lists all product classification systems available to a company based on its nexus.
639
- #
640
- # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
651
+ # Lists all product classification systems available to a company based on its nexus.
652
+ #
653
+ # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
641
654
  # More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
642
- # @param companyCode [String] The company code.
643
- # @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:* countries
644
- # @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.
645
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
646
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
655
+ # @param companyCode [String] The company code.
656
+ # @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:* countries
657
+ # @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.
658
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
659
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
647
660
  # @return [FetchResult]
648
661
  def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
649
662
  get(path, options) end
650
663
 
651
664
  # Retrieve the full list of rate types for each country
652
665
  #
653
- # Returns the full list of Avalara-supported rate type file types
666
+ # Returns the full list of Avalara-supported rate type file types
654
667
  # This API is intended to be useful to identify all the different rate types.
655
- # @param country [String] The country to examine for rate types
656
- # @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/).
657
- # @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.
658
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
659
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
668
+ # @param country [String] The country to examine for rate types
669
+ # @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/).
670
+ # @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.
671
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
672
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
660
673
  # @return [FetchResult]
661
674
  def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
662
675
  get(path, options) end
663
676
 
664
677
  # List all ISO 3166 regions
665
678
  #
666
- # Returns a list of all ISO 3166 region codes and their US English friendly names.
667
- # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
679
+ # Returns a list of all ISO 3166 region codes and their US English friendly names.
680
+ # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
668
681
  # within the country for a shipping addresses.
669
- # @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:* localizedNames
670
- # @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.
671
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
672
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
682
+ # @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:* localizedNames
683
+ # @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.
684
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
685
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
673
686
  # @return [FetchResult]
674
687
  def list_regions(options={}) path = "/api/v2/definitions/regions"
675
688
  get(path, options) end
676
689
 
677
690
  # List all ISO 3166 regions for a country
678
691
  #
679
- # Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
680
- # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
692
+ # Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
693
+ # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
681
694
  # within the country for a shipping addresses.
682
- # @param country [String] The country of which you want to fetch ISO 3166 regions
683
- # @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:* localizedNames
684
- # @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.
685
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
686
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
695
+ # @param country [String] The country of which you want to fetch ISO 3166 regions
696
+ # @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:* localizedNames
697
+ # @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.
698
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
699
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
687
700
  # @return [FetchResult]
688
701
  def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
689
702
  get(path, options) end
690
703
 
691
704
  # Retrieve the full list of Avalara-supported resource file types
692
705
  #
693
- # Returns the full list of Avalara-supported resource file types
706
+ # Returns the full list of Avalara-supported resource file types
694
707
  # This API is intended to be useful to identify all the different resource file types.
695
- # @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/).
696
- # @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.
697
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
698
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
708
+ # @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/).
709
+ # @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.
710
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
711
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
699
712
  # @return [FetchResult]
700
713
  def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
701
714
  get(path, options) end
702
715
 
703
716
  # Retrieve the full list of Avalara-supported permissions
704
717
  #
705
- # Returns the full list of Avalara-supported permission types.
706
- # This API is intended to be useful when designing a user interface for selecting the security role of a user account.
718
+ # Returns the full list of Avalara-supported permission types.
719
+ # This API is intended to be useful when designing a user interface for selecting the security role of a user account.
707
720
  # Some security roles are restricted for Avalara internal use.
708
- # @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/).
709
- # @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.
710
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
711
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
721
+ # @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/).
722
+ # @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.
723
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
724
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
712
725
  # @return [FetchResult]
713
726
  def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
714
727
  get(path, options) end
715
728
 
716
729
  # Retrieve the full list of Avalara-supported subscription types
717
730
  #
718
- # Returns the full list of Avalara-supported subscription types.
719
- # This API is intended to be useful for identifying which features you have added to your account.
720
- # You may always contact Avalara's sales department for information on available products or services.
731
+ # Returns the full list of Avalara-supported subscription types.
732
+ # This API is intended to be useful for identifying which features you have added to your account.
733
+ # You may always contact Avalara's sales department for information on available products or services.
721
734
  # You cannot change your subscriptions directly through the API.
722
- # @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/).
723
- # @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.
724
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
725
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
735
+ # @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/).
736
+ # @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.
737
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
738
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
726
739
  # @return [FetchResult]
727
740
  def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
728
741
  get(path, options) end
729
742
 
730
743
  # Retrieve the full list of Avalara-supported tax authorities.
731
744
  #
732
- # Returns the full list of Avalara-supported tax authorities.
745
+ # Returns the full list of Avalara-supported tax authorities.
733
746
  # This API is intended to be useful to identify all the different authorities that receive tax.
734
- # @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/).
735
- # @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.
736
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
737
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
747
+ # @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/).
748
+ # @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.
749
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
750
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
738
751
  # @return [FetchResult]
739
752
  def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
740
753
  get(path, options) end
741
754
 
742
755
  # Retrieve the full list of Avalara-supported forms for each tax authority.
743
756
  #
744
- # Returns the full list of Avalara-supported forms for each tax authority.
745
- # This list represents tax forms that Avalara recognizes.
746
- # Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
757
+ # Returns the full list of Avalara-supported forms for each tax authority.
758
+ # This list represents tax forms that Avalara recognizes.
759
+ # Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
747
760
  # based on the customer's AvaTax data.
748
- # @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/).
749
- # @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.
750
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
751
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
761
+ # @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/).
762
+ # @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.
763
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
764
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
752
765
  # @return [FetchResult]
753
766
  def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
754
767
  get(path, options) end
755
768
 
756
769
  # Retrieve the full list of Avalara-supported tax authority types.
757
770
  #
758
- # Returns the full list of Avalara-supported tax authority types.
771
+ # Returns the full list of Avalara-supported tax authority types.
759
772
  # This API is intended to be useful to identify all the different authority types.
760
- # @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/).
761
- # @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.
762
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
763
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
773
+ # @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/).
774
+ # @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.
775
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
776
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
764
777
  # @return [FetchResult]
765
778
  def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
766
779
  get(path, options) end
767
780
 
768
781
  # Retrieve the full list of Avalara-supported tax codes.
769
782
  #
770
- # Retrieves the list of Avalara-supported system tax codes.
771
- # A 'TaxCode' represents a uniquely identified type of product, good, or service.
772
- # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
773
- # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
774
- # taxability rules for this product in all supported jurisdictions.
775
- #
776
- # ### Security Policies
777
- #
783
+ # Retrieves the list of Avalara-supported system tax codes.
784
+ # A 'TaxCode' represents a uniquely identified type of product, good, or service.
785
+ # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
786
+ # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
787
+ # taxability rules for this product in all supported jurisdictions.
788
+ #
789
+ # ### Security Policies
790
+ #
778
791
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
779
- # @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/).
780
- # @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.
781
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
782
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
792
+ # @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/).
793
+ # @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.
794
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
795
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
783
796
  # @return [FetchResult]
784
797
  def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
785
798
  get(path, options) end
786
799
 
787
800
  # Retrieve the full list of Avalara-supported tax code types.
788
801
  #
789
- # Returns the full list of recognized tax code types.
790
- # A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
802
+ # Returns the full list of recognized tax code types.
803
+ # A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
791
804
  # This API is intended to be useful for broadly searching for tax codes by tax code type.
792
- # @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.
793
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
805
+ # @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.
806
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
794
807
  # @return [Object]
795
808
  def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
796
809
  get(path, options) end
797
810
 
798
811
  # Retrieve the full list of the Tax Forms available
799
812
  #
800
- # Returns the full list of Avalara-supported Tax Forms
813
+ # Returns the full list of Avalara-supported Tax Forms
801
814
  # This API is intended to be useful to identify all the different Tax Forms
802
- # @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/).
803
- # @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.
804
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
805
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
815
+ # @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/).
816
+ # @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.
817
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
818
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
806
819
  # @return [FetchResult]
807
820
  def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
808
821
  get(path, options) end
809
822
 
810
823
  # Retrieve the full list of tax sub types
811
824
  #
812
- # Returns the full list of Avalara-supported tax sub-types
825
+ # Returns the full list of Avalara-supported tax sub-types
813
826
  # This API is intended to be useful to identify all the different tax sub-types.
814
- # @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/).
815
- # @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.
816
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
817
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
827
+ # @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/).
828
+ # @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.
829
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
830
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
818
831
  # @return [FetchResult]
819
832
  def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
820
833
  get(path, options) end
821
834
 
822
835
  # Retrieve the full list of tax type groups
823
836
  #
824
- # Returns the full list of Avalara-supported tax type groups
837
+ # Returns the full list of Avalara-supported tax type groups
825
838
  # This API is intended to be useful to identify all the different tax type groups.
826
- # @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence
827
- # @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.
828
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
829
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
839
+ # @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence
840
+ # @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.
841
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
842
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
830
843
  # @return [FetchResult]
831
844
  def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
832
845
  get(path, options) end
833
846
 
834
847
  # List all defined units of measurement
835
848
  #
836
- # List all units of measurement systems defined by Avalara.
837
- #
849
+ # List all units of measurement systems defined by Avalara.
850
+ #
838
851
  # A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others.
839
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id
840
- # @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.
841
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
842
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
852
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id
853
+ # @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.
854
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
855
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
843
856
  # @return [FetchResult]
844
857
  def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
845
858
  get(path, options) end