avatax 20.1.0 → 20.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +180 -116
- data/lib/avatax/client/addresses.rb +34 -34
- data/lib/avatax/client/advancedrules.rb +33 -142
- data/lib/avatax/client/avafileforms.rb +37 -37
- data/lib/avatax/client/batches.rb +122 -122
- data/lib/avatax/client/certexpressinvites.rb +70 -70
- data/lib/avatax/client/certificates.rb +313 -313
- data/lib/avatax/client/companies.rb +234 -232
- data/lib/avatax/client/compliance.rb +2 -2
- data/lib/avatax/client/contacts.rb +58 -58
- data/lib/avatax/client/customers.rb +279 -279
- data/lib/avatax/client/datasources.rb +51 -51
- data/lib/avatax/client/definitions.rb +448 -435
- data/lib/avatax/client/distancethresholds.rb +74 -74
- data/lib/avatax/client/filingcalendars.rb +10 -498
- data/lib/avatax/client/filings.rb +13 -13
- data/lib/avatax/client/firmclientlinkages.rb +54 -54
- data/lib/avatax/client/free.rb +73 -73
- data/lib/avatax/client/fundingrequests.rb +32 -32
- data/lib/avatax/client/items.rb +284 -284
- data/lib/avatax/client/jurisdictionoverrides.rb +70 -70
- data/lib/avatax/client/locations.rb +87 -84
- data/lib/avatax/client/multidocument.rb +294 -234
- data/lib/avatax/client/nexus.rb +283 -143
- data/lib/avatax/client/notifications.rb +48 -48
- data/lib/avatax/client/provisioning.rb +29 -29
- data/lib/avatax/client/registrar.rb +122 -122
- data/lib/avatax/client/reports.rb +63 -63
- data/lib/avatax/client/settings.rb +108 -108
- data/lib/avatax/client/subscriptions.rb +35 -35
- data/lib/avatax/client/taxcodes.rb +72 -72
- data/lib/avatax/client/taxcontent.rb +106 -106
- data/lib/avatax/client/taxrules.rb +122 -122
- data/lib/avatax/client/transactions.rb +654 -639
- data/lib/avatax/client/upcs.rb +63 -63
- data/lib/avatax/client/users.rb +121 -121
- data/lib/avatax/client/utilities.rb +34 -34
- data/lib/avatax/connection.rb +1 -1
- data/lib/avatax/request.rb +2 -0
- data/lib/avatax/version.rb +1 -1
- metadata +3 -3
@@ -5,91 +5,91 @@ module AvaTax
|
|
5
5
|
|
6
6
|
# Download a report
|
7
7
|
#
|
8
|
-
# This API downloads the file associated with a report.
|
9
|
-
#
|
10
|
-
# If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
|
11
|
-
# use the `GetReport` API.
|
12
|
-
#
|
13
|
-
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
14
|
-
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
15
|
-
#
|
16
|
-
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
17
|
-
# * In the result of the Initiate API, you receive back a report's `id` value.
|
18
|
-
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
19
|
-
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
20
|
-
#
|
21
|
-
# This API works for all report types.
|
22
|
-
#
|
23
|
-
# ### Security Policies
|
24
|
-
#
|
8
|
+
# This API downloads the file associated with a report.
|
9
|
+
#
|
10
|
+
# If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
|
11
|
+
# use the `GetReport` API.
|
12
|
+
#
|
13
|
+
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
14
|
+
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
15
|
+
#
|
16
|
+
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
17
|
+
# * In the result of the Initiate API, you receive back a report's `id` value.
|
18
|
+
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
19
|
+
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
20
|
+
#
|
21
|
+
# This API works for all report types.
|
22
|
+
#
|
23
|
+
# ### Security Policies
|
24
|
+
#
|
25
25
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
26
|
-
# @param id [Integer] The unique ID number of this report
|
26
|
+
# @param id [Integer] The unique ID number of this report
|
27
27
|
# @return [Object]
|
28
28
|
def download_report(id) path = "/api/v2/reports/#{id}/attachment"
|
29
29
|
get(path) end
|
30
30
|
|
31
31
|
# Retrieve a single report
|
32
32
|
#
|
33
|
-
# Retrieve a single report by its unique ID number.
|
34
|
-
#
|
35
|
-
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
36
|
-
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
37
|
-
#
|
38
|
-
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
39
|
-
# * In the result of the Initiate API, you receive back a report's `id` value.
|
40
|
-
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
41
|
-
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
42
|
-
#
|
33
|
+
# Retrieve a single report by its unique ID number.
|
34
|
+
#
|
35
|
+
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
36
|
+
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
37
|
+
#
|
38
|
+
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
39
|
+
# * In the result of the Initiate API, you receive back a report's `id` value.
|
40
|
+
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
41
|
+
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
42
|
+
#
|
43
43
|
# This API call returns information about any report type.
|
44
|
-
# @param id [Integer] The unique ID number of the report to retrieve
|
44
|
+
# @param id [Integer] The unique ID number of the report to retrieve
|
45
45
|
# @return [Object]
|
46
46
|
def get_report(id) path = "/api/v2/reports/#{id}"
|
47
47
|
get(path) end
|
48
48
|
|
49
49
|
# Initiate an ExportDocumentLine report task
|
50
50
|
#
|
51
|
-
# Begins running an `ExportDocumentLine` report task and returns the identity of the report.
|
52
|
-
#
|
53
|
-
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
54
|
-
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
55
|
-
#
|
56
|
-
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
57
|
-
# * In the result of the Initiate API, you receive back a report's `id` value.
|
58
|
-
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
59
|
-
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
60
|
-
#
|
61
|
-
# The `ExportDocumentLine` report produces information about invoice lines recorded within your account.
|
62
|
-
#
|
63
|
-
# ### Security Policies
|
64
|
-
#
|
51
|
+
# Begins running an `ExportDocumentLine` report task and returns the identity of the report.
|
52
|
+
#
|
53
|
+
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
54
|
+
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
55
|
+
#
|
56
|
+
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
57
|
+
# * In the result of the Initiate API, you receive back a report's `id` value.
|
58
|
+
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
59
|
+
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
60
|
+
#
|
61
|
+
# The `ExportDocumentLine` report produces information about invoice lines recorded within your account.
|
62
|
+
#
|
63
|
+
# ### Security Policies
|
64
|
+
#
|
65
65
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
66
|
-
# @param companyId [Integer] The unique ID number of the company to report on.
|
67
|
-
# @param model [Object] Options that may be configured to customize the report.
|
66
|
+
# @param companyId [Integer] The unique ID number of the company to report on.
|
67
|
+
# @param model [Object] Options that may be configured to customize the report.
|
68
68
|
# @return [ReportModel[]]
|
69
69
|
def initiate_export_document_line_report(companyId, model) path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
|
70
70
|
post(path, model) end
|
71
71
|
|
72
72
|
# List all report tasks for account
|
73
73
|
#
|
74
|
-
# List all report tasks for your account.
|
75
|
-
#
|
76
|
-
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
77
|
-
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
78
|
-
#
|
79
|
-
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
80
|
-
# * In the result of the Initiate API, you receive back a report's `id` value.
|
81
|
-
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
82
|
-
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
83
|
-
#
|
84
|
-
# This API call returns information about all report types across your entire account.
|
85
|
-
#
|
86
|
-
# ### Security Policies
|
87
|
-
#
|
74
|
+
# List all report tasks for your account.
|
75
|
+
#
|
76
|
+
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
|
77
|
+
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
|
78
|
+
#
|
79
|
+
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
80
|
+
# * In the result of the Initiate API, you receive back a report's `id` value.
|
81
|
+
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
82
|
+
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
83
|
+
#
|
84
|
+
# This API call returns information about all report types across your entire account.
|
85
|
+
#
|
86
|
+
# ### Security Policies
|
87
|
+
#
|
88
88
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
89
|
-
# @param companyId [Integer] The id of the company for which to get reports.
|
90
|
-
# @param pageKey [String] Provide a page key to retrieve the next page of results.
|
91
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
92
|
-
# @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.
|
89
|
+
# @param companyId [Integer] The id of the company for which to get reports.
|
90
|
+
# @param pageKey [String] Provide a page key to retrieve the next page of results.
|
91
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
92
|
+
# @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.
|
93
93
|
# @return [FetchResult]
|
94
94
|
def list_reports(options={}) path = "/api/v2/reports"
|
95
95
|
get(path, options) end
|
@@ -5,150 +5,150 @@ module AvaTax
|
|
5
5
|
|
6
6
|
# Create a new setting
|
7
7
|
#
|
8
|
-
# Create one or more new setting objects attached to this company.
|
9
|
-
#
|
10
|
-
# The company settings system is a metadata system that you can use to store extra information
|
11
|
-
# about a company. Your integration or connector could use this data storage to keep track of
|
12
|
-
# preference information, reminders, or any other storage that would need to persist even if
|
13
|
-
# the customer uninstalls your application.
|
14
|
-
#
|
15
|
-
# A setting can refer to any type of data you need to remember about this company object.
|
16
|
-
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
17
|
-
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
18
|
-
#
|
19
|
-
# ### Security Policies
|
20
|
-
#
|
8
|
+
# Create one or more new setting objects attached to this company.
|
9
|
+
#
|
10
|
+
# The company settings system is a metadata system that you can use to store extra information
|
11
|
+
# about a company. Your integration or connector could use this data storage to keep track of
|
12
|
+
# preference information, reminders, or any other storage that would need to persist even if
|
13
|
+
# the customer uninstalls your application.
|
14
|
+
#
|
15
|
+
# A setting can refer to any type of data you need to remember about this company object.
|
16
|
+
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
17
|
+
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
18
|
+
#
|
19
|
+
# ### Security Policies
|
20
|
+
#
|
21
21
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
22
|
-
# @param companyId [Integer] The ID of the company that owns this setting.
|
23
|
-
# @param model [SettingModel[]] The setting you wish to create.
|
22
|
+
# @param companyId [Integer] The ID of the company that owns this setting.
|
23
|
+
# @param model [SettingModel[]] The setting you wish to create.
|
24
24
|
# @return [SettingModel[]]
|
25
25
|
def create_settings(companyId, model) path = "/api/v2/companies/#{companyId}/settings"
|
26
26
|
post(path, model) end
|
27
27
|
|
28
28
|
# Delete a single setting
|
29
29
|
#
|
30
|
-
# Mark the setting object at this URL as deleted.
|
31
|
-
#
|
32
|
-
# The company settings system is a metadata system that you can use to store extra information
|
33
|
-
# about a company. Your integration or connector could use this data storage to keep track of
|
34
|
-
# preference information, reminders, or any other storage that would need to persist even if
|
35
|
-
# the customer uninstalls your application.
|
36
|
-
#
|
37
|
-
# A setting can refer to any type of data you need to remember about this company object.
|
38
|
-
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
39
|
-
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
40
|
-
#
|
41
|
-
# ### Security Policies
|
42
|
-
#
|
30
|
+
# Mark the setting object at this URL as deleted.
|
31
|
+
#
|
32
|
+
# The company settings system is a metadata system that you can use to store extra information
|
33
|
+
# about a company. Your integration or connector could use this data storage to keep track of
|
34
|
+
# preference information, reminders, or any other storage that would need to persist even if
|
35
|
+
# the customer uninstalls your application.
|
36
|
+
#
|
37
|
+
# A setting can refer to any type of data you need to remember about this company object.
|
38
|
+
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
39
|
+
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
40
|
+
#
|
41
|
+
# ### Security Policies
|
42
|
+
#
|
43
43
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
44
|
-
# @param companyId [Integer] The ID of the company that owns this setting.
|
45
|
-
# @param id [Integer] The ID of the setting you wish to delete.
|
44
|
+
# @param companyId [Integer] The ID of the company that owns this setting.
|
45
|
+
# @param id [Integer] The ID of the setting you wish to delete.
|
46
46
|
# @return [ErrorDetail[]]
|
47
47
|
def delete_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
48
48
|
delete(path) end
|
49
49
|
|
50
50
|
# Retrieve a single setting
|
51
51
|
#
|
52
|
-
# Get a single setting object by its unique ID.
|
53
|
-
#
|
54
|
-
# The company settings system is a metadata system that you can use to store extra information
|
55
|
-
# about a company. Your integration or connector could use this data storage to keep track of
|
56
|
-
# preference information, reminders, or any other storage that would need to persist even if
|
57
|
-
# the customer uninstalls your application.
|
58
|
-
#
|
59
|
-
# A setting can refer to any type of data you need to remember about this company object.
|
60
|
-
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
61
|
-
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
62
|
-
#
|
63
|
-
# ### Security Policies
|
64
|
-
#
|
52
|
+
# Get a single setting object by its unique ID.
|
53
|
+
#
|
54
|
+
# The company settings system is a metadata system that you can use to store extra information
|
55
|
+
# about a company. Your integration or connector could use this data storage to keep track of
|
56
|
+
# preference information, reminders, or any other storage that would need to persist even if
|
57
|
+
# the customer uninstalls your application.
|
58
|
+
#
|
59
|
+
# A setting can refer to any type of data you need to remember about this company object.
|
60
|
+
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
61
|
+
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
62
|
+
#
|
63
|
+
# ### Security Policies
|
64
|
+
#
|
65
65
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
66
|
-
# @param companyId [Integer] The ID of the company that owns this setting
|
67
|
-
# @param id [Integer] The primary key of this setting
|
66
|
+
# @param companyId [Integer] The ID of the company that owns this setting
|
67
|
+
# @param id [Integer] The primary key of this setting
|
68
68
|
# @return [Object]
|
69
69
|
def get_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
70
70
|
get(path) end
|
71
71
|
|
72
72
|
# Retrieve all settings for this company
|
73
73
|
#
|
74
|
-
# List all setting objects attached to this company.
|
75
|
-
#
|
76
|
-
# The company settings system is a metadata system that you can use to store extra information
|
77
|
-
# about a company. Your integration or connector could use this data storage to keep track of
|
78
|
-
# preference information, reminders, or any other storage that would need to persist even if
|
79
|
-
# the customer uninstalls your application.
|
80
|
-
#
|
81
|
-
# A setting can refer to any type of data you need to remember about this company object.
|
82
|
-
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
83
|
-
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
84
|
-
#
|
85
|
-
# 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/) .
|
86
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
87
|
-
#
|
88
|
-
# ### Security Policies
|
89
|
-
#
|
74
|
+
# List all setting objects attached to this company.
|
75
|
+
#
|
76
|
+
# The company settings system is a metadata system that you can use to store extra information
|
77
|
+
# about a company. Your integration or connector could use this data storage to keep track of
|
78
|
+
# preference information, reminders, or any other storage that would need to persist even if
|
79
|
+
# the customer uninstalls your application.
|
80
|
+
#
|
81
|
+
# A setting can refer to any type of data you need to remember about this company object.
|
82
|
+
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
83
|
+
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
84
|
+
#
|
85
|
+
# 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/) .
|
86
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
87
|
+
#
|
88
|
+
# ### Security Policies
|
89
|
+
#
|
90
90
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
91
|
-
# @param companyId [Integer] The ID of the company that owns these settings
|
92
|
-
# @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/).
|
93
|
-
# @param include [String] A comma separated list of additional data to retrieve.
|
94
|
-
# @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.
|
95
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
96
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
91
|
+
# @param companyId [Integer] The ID of the company that owns these settings
|
92
|
+
# @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/).
|
93
|
+
# @param include [String] A comma separated list of additional data to retrieve.
|
94
|
+
# @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.
|
95
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
96
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
97
97
|
# @return [FetchResult]
|
98
98
|
def list_settings_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/settings"
|
99
99
|
get(path, options) end
|
100
100
|
|
101
101
|
# Retrieve all settings
|
102
102
|
#
|
103
|
-
# Get multiple setting objects across all companies.
|
104
|
-
#
|
105
|
-
# The company settings system is a metadata system that you can use to store extra information
|
106
|
-
# about a company. Your integration or connector could use this data storage to keep track of
|
107
|
-
# preference information, reminders, or any other storage that would need to persist even if
|
108
|
-
# the customer uninstalls your application.
|
109
|
-
#
|
110
|
-
# A setting can refer to any type of data you need to remember about this company object.
|
111
|
-
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
112
|
-
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
113
|
-
#
|
114
|
-
# 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/) .
|
115
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
116
|
-
#
|
117
|
-
# ### Security Policies
|
118
|
-
#
|
103
|
+
# Get multiple setting objects across all companies.
|
104
|
+
#
|
105
|
+
# The company settings system is a metadata system that you can use to store extra information
|
106
|
+
# about a company. Your integration or connector could use this data storage to keep track of
|
107
|
+
# preference information, reminders, or any other storage that would need to persist even if
|
108
|
+
# the customer uninstalls your application.
|
109
|
+
#
|
110
|
+
# A setting can refer to any type of data you need to remember about this company object.
|
111
|
+
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
112
|
+
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
113
|
+
#
|
114
|
+
# 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/) .
|
115
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
116
|
+
#
|
117
|
+
# ### Security Policies
|
118
|
+
#
|
119
119
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
120
|
-
# @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/).
|
121
|
-
# @param include [String] A comma separated list of additional data to retrieve.
|
122
|
-
# @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.
|
123
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
124
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
120
|
+
# @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/).
|
121
|
+
# @param include [String] A comma separated list of additional data to retrieve.
|
122
|
+
# @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.
|
123
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
124
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
125
125
|
# @return [FetchResult]
|
126
126
|
def query_settings(options={}) path = "/api/v2/settings"
|
127
127
|
get(path, options) end
|
128
128
|
|
129
129
|
# Update a single setting
|
130
130
|
#
|
131
|
-
# Replace the existing setting object at this URL with an updated object.
|
132
|
-
#
|
133
|
-
# The company settings system is a metadata system that you can use to store extra information
|
134
|
-
# about a company. Your integration or connector could use this data storage to keep track of
|
135
|
-
# preference information, reminders, or any other storage that would need to persist even if
|
136
|
-
# the customer uninstalls your application.
|
137
|
-
#
|
138
|
-
# A setting can refer to any type of data you need to remember about this company object.
|
139
|
-
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
140
|
-
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
141
|
-
#
|
142
|
-
# All data from the existing object will be replaced with data in the object you `PUT`.
|
143
|
-
#
|
144
|
-
# To set a field's value to `null`, you may either set its value to `null` or omit that field from the object when calling update.
|
145
|
-
#
|
146
|
-
# ### Security Policies
|
147
|
-
#
|
131
|
+
# Replace the existing setting object at this URL with an updated object.
|
132
|
+
#
|
133
|
+
# The company settings system is a metadata system that you can use to store extra information
|
134
|
+
# about a company. Your integration or connector could use this data storage to keep track of
|
135
|
+
# preference information, reminders, or any other storage that would need to persist even if
|
136
|
+
# the customer uninstalls your application.
|
137
|
+
#
|
138
|
+
# A setting can refer to any type of data you need to remember about this company object.
|
139
|
+
# When creating this object, you may define your own `set`, `name`, and `value` parameters.
|
140
|
+
# To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
|
141
|
+
#
|
142
|
+
# All data from the existing object will be replaced with data in the object you `PUT`.
|
143
|
+
#
|
144
|
+
# To set a field's value to `null`, you may either set its value to `null` or omit that field from the object when calling update.
|
145
|
+
#
|
146
|
+
# ### Security Policies
|
147
|
+
#
|
148
148
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
149
|
-
# @param companyId [Integer] The ID of the company that this setting belongs to.
|
150
|
-
# @param id [Integer] The ID of the setting you wish to update
|
151
|
-
# @param model [Object] The setting you wish to update.
|
149
|
+
# @param companyId [Integer] The ID of the company that this setting belongs to.
|
150
|
+
# @param id [Integer] The ID of the setting you wish to update
|
151
|
+
# @param model [Object] The setting you wish to update.
|
152
152
|
# @return [Object]
|
153
153
|
def update_setting(companyId, id, model) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
154
154
|
put(path, model) end
|
@@ -5,56 +5,56 @@ module AvaTax
|
|
5
5
|
|
6
6
|
# Retrieve a single subscription
|
7
7
|
#
|
8
|
-
# Get the subscription object identified by this URL.
|
9
|
-
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
10
|
-
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
11
|
-
#
|
12
|
-
# ### Security Policies
|
13
|
-
#
|
8
|
+
# Get the subscription object identified by this URL.
|
9
|
+
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
10
|
+
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
11
|
+
#
|
12
|
+
# ### Security Policies
|
13
|
+
#
|
14
14
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
15
|
-
# @param accountId [Integer] The ID of the account that owns this subscription
|
16
|
-
# @param id [Integer] The primary key of this subscription
|
15
|
+
# @param accountId [Integer] The ID of the account that owns this subscription
|
16
|
+
# @param id [Integer] The primary key of this subscription
|
17
17
|
# @return [Object]
|
18
18
|
def get_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
|
19
19
|
get(path) end
|
20
20
|
|
21
21
|
# Retrieve subscriptions for this account
|
22
22
|
#
|
23
|
-
# List all subscription objects attached to this account.
|
24
|
-
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
25
|
-
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
26
|
-
#
|
27
|
-
# 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/) .
|
28
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
29
|
-
#
|
30
|
-
# ### Security Policies
|
31
|
-
#
|
23
|
+
# List all subscription objects attached to this account.
|
24
|
+
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
25
|
+
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
26
|
+
#
|
27
|
+
# 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/) .
|
28
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
29
|
+
#
|
30
|
+
# ### Security Policies
|
31
|
+
#
|
32
32
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
33
|
-
# @param accountId [Integer] The ID of the account that owns these subscriptions
|
34
|
-
# @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:* subscriptionDescription
|
35
|
-
# @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.
|
36
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
37
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
33
|
+
# @param accountId [Integer] The ID of the account that owns these subscriptions
|
34
|
+
# @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:* subscriptionDescription
|
35
|
+
# @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.
|
36
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
37
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
38
38
|
# @return [FetchResult]
|
39
39
|
def list_subscriptions_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/subscriptions"
|
40
40
|
get(path, options) end
|
41
41
|
|
42
42
|
# Retrieve all subscriptions
|
43
43
|
#
|
44
|
-
# Get multiple subscription objects across all accounts.
|
45
|
-
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
46
|
-
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
47
|
-
#
|
48
|
-
# 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/) .
|
49
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
50
|
-
#
|
51
|
-
# ### Security Policies
|
52
|
-
#
|
44
|
+
# Get multiple subscription objects across all accounts.
|
45
|
+
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
46
|
+
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
47
|
+
#
|
48
|
+
# 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/) .
|
49
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
50
|
+
#
|
51
|
+
# ### Security Policies
|
52
|
+
#
|
53
53
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
54
|
-
# @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:* subscriptionDescription
|
55
|
-
# @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.
|
56
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
57
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
54
|
+
# @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:* subscriptionDescription
|
55
|
+
# @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.
|
56
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
57
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
58
58
|
# @return [FetchResult]
|
59
59
|
def query_subscriptions(options={}) path = "/api/v2/subscriptions"
|
60
60
|
get(path, options) end
|