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.
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,72 +5,72 @@ module AvaTax
5
5
 
6
6
  # Create a new AvaFileForm
7
7
  #
8
- # Create one or more AvaFileForms
9
- # A 'AvaFileForm' represents a form supported by our returns team
10
- #
11
- # ### Security Policies
12
- #
13
- # * This API requires the user role Compliance Root User.
8
+ # Create one or more AvaFileForms
9
+ # A 'AvaFileForm' represents a form supported by our returns team
10
+ #
11
+ # ### Security Policies
12
+ #
13
+ # * This API requires the user role Compliance Root User.
14
14
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
15
- # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
15
+ # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
16
16
  # @return [AvaFileFormModel[]]
17
17
  def create_ava_file_forms(model) path = "/api/v2/avafileforms"
18
18
  post(path, model) end
19
19
 
20
20
  # Delete a single AvaFileForm
21
21
  #
22
- # Marks the existing AvaFileForm object at this URL as deleted.
23
- #
24
- # ### Security Policies
25
- #
26
- # * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
22
+ # Marks the existing AvaFileForm object at this URL as deleted.
23
+ #
24
+ # ### Security Policies
25
+ #
26
+ # * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
27
27
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
28
- # @param id [Integer] The ID of the AvaFileForm you wish to delete.
28
+ # @param id [Integer] The ID of the AvaFileForm you wish to delete.
29
29
  # @return [ErrorDetail[]]
30
30
  def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
31
31
  delete(path) end
32
32
 
33
33
  # Retrieve a single AvaFileForm
34
34
  #
35
- # Get the AvaFileForm object identified by this URL.
36
- #
37
- # ### Security Policies
38
- #
39
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
35
+ # Get the AvaFileForm object identified by this URL.
36
+ #
37
+ # ### Security Policies
38
+ #
39
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
40
40
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
41
- # @param id [Integer] The primary key of this AvaFileForm
41
+ # @param id [Integer] The primary key of this AvaFileForm
42
42
  # @return [Object]
43
43
  def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
44
44
  get(path) end
45
45
 
46
46
  # Retrieve all AvaFileForms
47
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
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
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
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
54
54
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
55
- # @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
56
- # @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.
57
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
58
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
55
+ # @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
56
+ # @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.
57
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
58
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
59
59
  # @return [FetchResult]
60
60
  def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
61
61
  get(path, options) end
62
62
 
63
63
  # Update a AvaFileForm
64
64
  #
65
- # All data from the existing object will be replaced with data in the object you PUT.
66
- # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
67
- #
68
- # ### Security Policies
69
- #
70
- # * This API requires the user role Compliance Root User.
65
+ # All data from the existing object will be replaced with data in the object you PUT.
66
+ # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
67
+ #
68
+ # ### Security Policies
69
+ #
70
+ # * This API requires the user role Compliance Root User.
71
71
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
72
- # @param id [Integer] The ID of the AvaFileForm you wish to update
73
- # @param model [Object] The AvaFileForm model you wish to update.
72
+ # @param id [Integer] The ID of the AvaFileForm you wish to update
73
+ # @param model [Object] The AvaFileForm model you wish to update.
74
74
  # @return [Object]
75
75
  def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
76
76
  put(path, model) end
@@ -5,164 +5,164 @@ module AvaTax
5
5
 
6
6
  # Create a new batch
7
7
  #
8
- # Create one or more new batch objects attached to this company.
9
- #
10
- # Each batch object may have one or more file objects (currently only one file is supported).
11
- #
12
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
13
- # processed as quickly as possible in the order it was received. To check the
14
- # status of a batch, fetch the batch and retrieve the results of the batch
15
- # operation.
16
- #
17
- # Because the batch system processes with a degree of concurrency, and
18
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
19
- # predict when a batch will complete. If high performance processing is
20
- # required, please use the
21
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
22
- #
23
- # The maximum content length of the request body is limited to 28.6 MB. If this limit
24
- # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
25
- # the API is called from a browser). In this situation, please split the request into
26
- # smaller batches.
27
- #
28
- # ### Security Policies
29
- #
8
+ # Create one or more new batch objects attached to this company.
9
+ #
10
+ # Each batch object may have one or more file objects (currently only one file is supported).
11
+ #
12
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
13
+ # processed as quickly as possible in the order it was received. To check the
14
+ # status of a batch, fetch the batch and retrieve the results of the batch
15
+ # operation.
16
+ #
17
+ # Because the batch system processes with a degree of concurrency, and
18
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
19
+ # predict when a batch will complete. If high performance processing is
20
+ # required, please use the
21
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
22
+ #
23
+ # The maximum content length of the request body is limited to 28.6 MB. If this limit
24
+ # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
25
+ # the API is called from a browser). In this situation, please split the request into
26
+ # smaller batches.
27
+ #
28
+ # ### Security Policies
29
+ #
30
30
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
31
- # @param companyId [Integer] The ID of the company that owns this batch.
32
- # @param model [BatchModel[]] The batch you wish to create.
31
+ # @param companyId [Integer] The ID of the company that owns this batch.
32
+ # @param model [BatchModel[]] The batch you wish to create.
33
33
  # @return [BatchModel[]]
34
34
  def create_batches(companyId, model) path = "/api/v2/companies/#{companyId}/batches"
35
35
  post(path, model) end
36
36
 
37
37
  # Delete a single batch
38
38
  #
39
- # Marks the batch identified by this URL as deleted.
40
- #
41
- # If you attempt to delete a batch that is being processed, you will receive an error message.
42
- # Deleting a batch does not delete any transactions that were created by importing the batch.
43
- #
44
- # Because the batch system processes with a degree of concurrency, and
45
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
46
- # predict when a batch will complete. If high performance processing is
47
- # required, please use the
48
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
49
- #
50
- # ### Security Policies
51
- #
39
+ # Marks the batch identified by this URL as deleted.
40
+ #
41
+ # If you attempt to delete a batch that is being processed, you will receive an error message.
42
+ # Deleting a batch does not delete any transactions that were created by importing the batch.
43
+ #
44
+ # Because the batch system processes with a degree of concurrency, and
45
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
46
+ # predict when a batch will complete. If high performance processing is
47
+ # required, please use the
48
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
49
+ #
50
+ # ### Security Policies
51
+ #
52
52
  # * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
53
- # @param companyId [Integer] The ID of the company that owns this batch.
54
- # @param id [Integer] The ID of the batch to delete.
53
+ # @param companyId [Integer] The ID of the company that owns this batch.
54
+ # @param id [Integer] The ID of the batch to delete.
55
55
  # @return [ErrorDetail[]]
56
56
  def delete_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
57
57
  delete(path) end
58
58
 
59
59
  # Download a single batch file
60
60
  #
61
- # Download a single batch file identified by this URL.
62
- #
63
- # ### Security Policies
64
- #
61
+ # Download a single batch file identified by this URL.
62
+ #
63
+ # ### Security Policies
64
+ #
65
65
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
66
- # @param companyId [Integer] The ID of the company that owns this batch
67
- # @param batchId [Integer] The ID of the batch object
68
- # @param id [Integer] The primary key of this batch file object
66
+ # @param companyId [Integer] The ID of the company that owns this batch
67
+ # @param batchId [Integer] The ID of the batch object
68
+ # @param id [Integer] The primary key of this batch file object
69
69
  # @return [Object]
70
70
  def download_batch(companyId, batchId, id) path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
71
71
  get(path) end
72
72
 
73
73
  # Retrieve a single batch
74
74
  #
75
- # Get the batch object identified by this URL. A batch object is a large
76
- # collection of API calls stored in a compact file.
77
- #
78
- # Use this endpoint to retrieve the results or check the status of a batch.
79
- #
80
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
81
- # processed as quickly as possible in the order it was received. To check the
82
- # status of a batch, fetch the batch and retrieve the results of the batch
83
- # operation.
84
- #
85
- # Because the batch system processes with a degree of concurrency, and
86
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
87
- # predict when a batch will complete. If high performance processing is
88
- # required, please use the
89
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
90
- #
91
- # ### Security Policies
92
- #
75
+ # Get the batch object identified by this URL. A batch object is a large
76
+ # collection of API calls stored in a compact file.
77
+ #
78
+ # Use this endpoint to retrieve the results or check the status of a batch.
79
+ #
80
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
81
+ # processed as quickly as possible in the order it was received. To check the
82
+ # status of a batch, fetch the batch and retrieve the results of the batch
83
+ # operation.
84
+ #
85
+ # Because the batch system processes with a degree of concurrency, and
86
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
87
+ # predict when a batch will complete. If high performance processing is
88
+ # required, please use the
89
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
90
+ #
91
+ # ### Security Policies
92
+ #
93
93
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
94
- # @param companyId [Integer] The ID of the company that owns this batch
95
- # @param id [Integer] The primary key of this batch
94
+ # @param companyId [Integer] The ID of the company that owns this batch
95
+ # @param id [Integer] The primary key of this batch
96
96
  # @return [Object]
97
97
  def get_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
98
98
  get(path) end
99
99
 
100
100
  # Retrieve all batches for this company
101
101
  #
102
- # List all batch objects attached to the specified company.
103
- #
104
- # A batch object is a large collection of API calls stored in a compact file.
105
- #
106
- # Search for specific objects using the criteria in the `$filter` parameter;
107
- # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
108
- # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
109
- #
110
- # Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)
111
- # to retrieve the results, or check the status, of an individual batch.
112
- #
113
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
114
- # processed as quickly as possible in the order it was received. To check the
115
- # status of a batch, fetch the batch and retrieve the results of the batch
116
- # operation.
117
- #
118
- # Because the batch system processes with a degree of concurrency, and
119
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
120
- # predict when a batch will complete. If high performance processing is
121
- # required, please use the
122
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
123
- #
124
- # ### Security Policies
125
- #
102
+ # List all batch objects attached to the specified company.
103
+ #
104
+ # A batch object is a large collection of API calls stored in a compact file.
105
+ #
106
+ # Search for specific objects using the criteria in the `$filter` parameter;
107
+ # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
108
+ # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
109
+ #
110
+ # Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)
111
+ # to retrieve the results, or check the status, of an individual batch.
112
+ #
113
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
114
+ # processed as quickly as possible in the order it was received. To check the
115
+ # status of a batch, fetch the batch and retrieve the results of the batch
116
+ # operation.
117
+ #
118
+ # Because the batch system processes with a degree of concurrency, and
119
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
120
+ # predict when a batch will complete. If high performance processing is
121
+ # required, please use the
122
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
123
+ #
124
+ # ### Security Policies
125
+ #
126
126
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
127
- # @param companyId [Integer] The ID of the company that owns these batches
128
- # @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:* files
129
- # @param include [String] A comma separated list of additional data to retrieve.
130
- # @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.
131
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
132
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
127
+ # @param companyId [Integer] The ID of the company that owns these batches
128
+ # @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:* files
129
+ # @param include [String] A comma separated list of additional data to retrieve.
130
+ # @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.
131
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
132
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
133
133
  # @return [FetchResult]
134
134
  def list_batches_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/batches"
135
135
  get(path, options) end
136
136
 
137
137
  # Retrieve all batches
138
138
  #
139
- # Get multiple batch objects across all companies.
140
- #
141
- # A batch object is a large collection of API calls stored in a compact file.
142
- #
143
- # Search for specific objects using the criteria in the `$filter` parameter;
144
- # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
145
- # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
146
- #
147
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
148
- # processed as quickly as possible in the order it was received. To check the
149
- # status of a batch, fetch the batch and retrieve the results of the batch
150
- # operation.
151
- #
152
- # Because the batch system processes with a degree of concurrency, and
153
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
154
- # predict when a batch will complete. If high performance processing is
155
- # required, please use the
156
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
157
- #
158
- # ### Security Policies
159
- #
139
+ # Get multiple batch objects across all companies.
140
+ #
141
+ # A batch object is a large collection of API calls stored in a compact file.
142
+ #
143
+ # Search for specific objects using the criteria in the `$filter` parameter;
144
+ # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
145
+ # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
146
+ #
147
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
148
+ # processed as quickly as possible in the order it was received. To check the
149
+ # status of a batch, fetch the batch and retrieve the results of the batch
150
+ # operation.
151
+ #
152
+ # Because the batch system processes with a degree of concurrency, and
153
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
154
+ # predict when a batch will complete. If high performance processing is
155
+ # required, please use the
156
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
157
+ #
158
+ # ### Security Policies
159
+ #
160
160
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
161
- # @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:* files
162
- # @param include [String] A comma separated list of additional data to retrieve.
163
- # @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.
164
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
165
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
161
+ # @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:* files
162
+ # @param include [String] A comma separated list of additional data to retrieve.
163
+ # @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.
164
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
165
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
166
166
  # @return [FetchResult]
167
167
  def query_batches(options={}) path = "/api/v2/batches"
168
168
  get(path, options) end
@@ -5,91 +5,91 @@ module AvaTax
5
5
 
6
6
  # Create a CertExpress invitation
7
7
  #
8
- # Creates an invitation for a customer to self-report certificates using the CertExpress website.
9
- #
10
- # This invitation is delivered by your choice of method, or you can present a hyperlink to the user
11
- # directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where
12
- # they can follow a step-by-step guide to enter information about their exemption certificates. The
13
- # certificates entered will be recorded and automatically linked to their customer record.
14
- #
15
- # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
16
- # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
17
- # your company so that they can be used for tax exemptions.
18
- #
19
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
20
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
21
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
22
- # storage for this company, call `RequestCertificateSetup`.
23
- #
24
- # ### Security Policies
25
- #
26
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
8
+ # Creates an invitation for a customer to self-report certificates using the CertExpress website.
9
+ #
10
+ # This invitation is delivered by your choice of method, or you can present a hyperlink to the user
11
+ # directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where
12
+ # they can follow a step-by-step guide to enter information about their exemption certificates. The
13
+ # certificates entered will be recorded and automatically linked to their customer record.
14
+ #
15
+ # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
16
+ # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
17
+ # your company so that they can be used for tax exemptions.
18
+ #
19
+ # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
20
+ # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
21
+ # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
22
+ # storage for this company, call `RequestCertificateSetup`.
23
+ #
24
+ # ### Security Policies
25
+ #
26
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
27
27
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
28
- # @param companyId [Integer] The unique ID number of the company that will record certificates
29
- # @param customerCode [String] The number of the customer where the request is sent to
30
- # @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
28
+ # @param companyId [Integer] The unique ID number of the company that will record certificates
29
+ # @param customerCode [String] The number of the customer where the request is sent to
30
+ # @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
31
31
  # @return [CertExpressInvitationStatusModel[]]
32
32
  def create_cert_express_invitation(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
33
33
  post(path, model) end
34
34
 
35
35
  # Retrieve a single CertExpress invitation
36
36
  #
37
- # Retrieve an existing CertExpress invitation sent to a customer.
38
- #
39
- # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
40
- # about their certificates. This step by step guide allows the customer to complete and upload the full
41
- # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
42
- # they will automatically be recorded to your company and linked to the customer record.
43
- #
44
- # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
45
- # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
46
- # your company so that they can be used for tax exemptions.
47
- #
48
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
49
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
50
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
51
- # storage for this company, call `RequestCertificateSetup`.
52
- #
53
- # ### Security Policies
54
- #
55
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
37
+ # Retrieve an existing CertExpress invitation sent to a customer.
38
+ #
39
+ # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
40
+ # about their certificates. This step by step guide allows the customer to complete and upload the full
41
+ # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
42
+ # they will automatically be recorded to your company and linked to the customer record.
43
+ #
44
+ # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
45
+ # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
46
+ # your company so that they can be used for tax exemptions.
47
+ #
48
+ # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
49
+ # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
50
+ # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
51
+ # storage for this company, call `RequestCertificateSetup`.
52
+ #
53
+ # ### Security Policies
54
+ #
55
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
56
56
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
57
- # @param companyId [Integer] The unique ID number of the company that issued this invitation
58
- # @param customerCode [String] The number of the customer where the request is sent to
59
- # @param id [Integer] The unique ID number of this CertExpress invitation
60
- # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
57
+ # @param companyId [Integer] The unique ID number of the company that issued this invitation
58
+ # @param customerCode [String] The number of the customer where the request is sent to
59
+ # @param id [Integer] The unique ID number of this CertExpress invitation
60
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
61
61
  # @return [Object]
62
62
  def get_cert_express_invitation(companyId, customerCode, id, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
63
63
  get(path, options) end
64
64
 
65
65
  # List CertExpress invitations
66
66
  #
67
- # Retrieve CertExpress invitations sent by this company.
68
- #
69
- # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
70
- # about their certificates. This step by step guide allows the customer to complete and upload the full
71
- # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
72
- # they will automatically be recorded to your company and linked to the customer record.
73
- #
74
- # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
75
- # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
76
- # your company so that they can be used for tax exemptions.
77
- #
78
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
79
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
80
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
81
- # storage for this company, call `RequestCertificateSetup`.
82
- #
83
- # ### Security Policies
84
- #
85
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
67
+ # Retrieve CertExpress invitations sent by this company.
68
+ #
69
+ # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
70
+ # about their certificates. This step by step guide allows the customer to complete and upload the full
71
+ # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
72
+ # they will automatically be recorded to your company and linked to the customer record.
73
+ #
74
+ # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
75
+ # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
76
+ # your company so that they can be used for tax exemptions.
77
+ #
78
+ # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
79
+ # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
80
+ # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
81
+ # storage for this company, call `RequestCertificateSetup`.
82
+ #
83
+ # ### Security Policies
84
+ #
85
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
86
86
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
87
- # @param companyId [Integer] The unique ID number of the company that issued this invitation
88
- # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
89
- # @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:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink
90
- # @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.
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 orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
87
+ # @param companyId [Integer] The unique ID number of the company that issued this invitation
88
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
89
+ # @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:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink
90
+ # @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.
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 orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
93
93
  # @return [FetchResult]
94
94
  def list_cert_express_invitations(companyId, options={}) path = "/api/v2/companies/#{companyId}/certexpressinvites"
95
95
  get(path, options) end