You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/Methods.php
+51-21Lines changed: 51 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -2412,7 +2412,7 @@ public function listMrsCompanies() {
2412
2412
* Swagger Name: AvaTaxClient
2413
2413
*
2414
2414
* @param string $include A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
2415
-
* @param string $filter 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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
2415
+
* @param string $filter 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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers, isAdvSave
2416
2416
* @param int $top 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.
2417
2417
* @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
2418
2418
* @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -4234,7 +4234,7 @@ public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orde
4234
4234
*
4235
4235
* ### Security Policies
4236
4236
*
4237
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4237
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4238
4238
* Swagger Name: AvaTaxClient
4239
4239
*
4240
4240
* @return \stdClass
@@ -4253,7 +4253,7 @@ public function listItemHSCodeClassificationStatus() {
4253
4253
*
4254
4254
* ### Security Policies
4255
4255
*
4256
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4256
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4257
4257
* Swagger Name: AvaTaxClient
4258
4258
*
4259
4259
* @return \stdClass
@@ -4272,7 +4272,7 @@ public function listItemsRecommendationsStatus() {
4272
4272
*
4273
4273
* ### Security Policies
4274
4274
*
4275
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4275
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4276
4276
* Swagger Name: AvaTaxClient
4277
4277
*
4278
4278
* @return \stdClass
@@ -4949,7 +4949,7 @@ public function listParametersByAccount($accountId, $filter=null, $top=null, $sk
4949
4949
*
4950
4950
* ### Security Policies
4951
4951
*
4952
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4952
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
4953
4953
* Swagger Name: AvaTaxClient
4954
4954
*
4955
4955
* @param string $companyCode Company code.
@@ -6896,7 +6896,7 @@ public function dismissHSCodeClassificationStatus($companyId, $itemId, $country)
6896
6896
*
6897
6897
* ### Security Policies
6898
6898
*
6899
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6899
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6900
6900
* Swagger Name: AvaTaxClient
6901
6901
*
6902
6902
* @param int $companyId The ID of the company for which to retrieve the SLA details.
@@ -6924,7 +6924,7 @@ public function getHSCodeClassificationSLA($companyId) {
6924
6924
*
6925
6925
* ### Security Policies
6926
6926
*
6927
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6927
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6928
6928
* Swagger Name: AvaTaxClient
6929
6929
*
6930
6930
* @param int $companyId The ID of the company that owns this item object
@@ -6952,7 +6952,7 @@ public function getItem($companyId, $id, $include=null) {
6952
6952
*
6953
6953
* ### Security Policies
6954
6954
*
6955
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6955
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6956
6956
* Swagger Name: AvaTaxClient
6957
6957
*
6958
6958
* @param int $companyId The company id.
@@ -6982,7 +6982,7 @@ public function getItemClassification($companyId, $itemId, $id) {
6982
6982
*
6983
6983
* ### Security Policies
6984
6984
*
6985
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6985
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
6986
6986
* Swagger Name: AvaTaxClient
6987
6987
*
6988
6988
* @param int $companyId The company id
@@ -7008,7 +7008,7 @@ public function getItemParameter($companyId, $itemId, $id) {
7008
7008
*
7009
7009
* ### Security Policies
7010
7010
*
7011
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7011
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7012
7012
* Swagger Name: AvaTaxClient
7013
7013
*
7014
7014
* @param int $companyId The ID of the company that defined these items
@@ -7034,7 +7034,7 @@ public function getItemTags($companyId, $itemId, $filter=null, $top=null, $skip=
7034
7034
*
7035
7035
* ### Security Policies
7036
7036
*
7037
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7037
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7038
7038
* Swagger Name: AvaTaxClient
7039
7039
*
7040
7040
* @param int $companyId
@@ -7066,7 +7066,7 @@ public function getItemTaxCodeRecommendations($companyId, $itemId) {
7066
7066
*
7067
7067
* ### Security Policies
7068
7068
*
7069
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7069
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7070
7070
* Swagger Name: AvaTaxClient
7071
7071
*
7072
7072
* @param int $companyId The ID of the company that owns this item object
@@ -7121,7 +7121,7 @@ public function initiateHSCodeClassification($companyId, $model=null) {
7121
7121
*
7122
7122
* ### Security Policies
7123
7123
*
7124
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7124
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7125
7125
* Swagger Name: AvaTaxClient
7126
7126
*
7127
7127
* @param int $companyId The ID of the company that owns this item object
@@ -7155,7 +7155,7 @@ public function listImportRestrictions($companyId, $itemCode, $countryOfImport,
7155
7155
*
7156
7156
* ### Security Policies
7157
7157
*
7158
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7158
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7159
7159
* Swagger Name: AvaTaxClient
7160
7160
*
7161
7161
* @param int $companyId The company id.
@@ -7191,7 +7191,7 @@ public function listItemClassifications($companyId, $itemId, $filter=null, $top=
7191
7191
*
7192
7192
* ### Security Policies
7193
7193
*
7194
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7194
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7195
7195
* Swagger Name: AvaTaxClient
7196
7196
*
7197
7197
* @param int $companyId The company id
@@ -7227,7 +7227,7 @@ public function listItemParameters($companyId, $itemId, $filter=null, $top=null,
7227
7227
*
7228
7228
* ### Security Policies
7229
7229
*
7230
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7230
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7231
7231
* Swagger Name: AvaTaxClient
7232
7232
*
7233
7233
* @param int $companyId The ID of the company that owns this item object.
@@ -7286,7 +7286,7 @@ public function listItemPremiumClassifications($companyId, $itemCode, $filter=nu
7286
7286
*
7287
7287
* ### Security Policies
7288
7288
*
7289
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7289
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7290
7290
* Swagger Name: AvaTaxClient
7291
7291
*
7292
7292
* @param int $companyId The ID of the company that defined these items
@@ -7321,7 +7321,7 @@ public function listItemsByCompany($companyId, $filter=null, $include=null, $top
7321
7321
*
7322
7322
* ### Security Policies
7323
7323
*
7324
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7324
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7325
7325
* Swagger Name: AvaTaxClient
7326
7326
*
7327
7327
* @param int $companyId Company Identifier.
@@ -7393,7 +7393,7 @@ public function patchItem($companyId, $id, $model=null) {
7393
7393
*
7394
7394
* ### Security Policies
7395
7395
*
7396
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7396
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7397
7397
* Swagger Name: AvaTaxClient
7398
7398
*
7399
7399
* @param string $filter 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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus
@@ -7429,7 +7429,7 @@ public function queryItems($filter=null, $include=null, $top=null, $skip=null, $
7429
7429
*
7430
7430
* ### Security Policies
7431
7431
*
7432
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7432
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7433
7433
* Swagger Name: AvaTaxClient
7434
7434
*
7435
7435
* @param int $companyId The ID of the company that defined these items
@@ -7466,7 +7466,7 @@ public function queryItemsBySystemCode($companyId, $systemCode, $top=null, $skip
7466
7466
*
7467
7467
* ### Security Policies
7468
7468
*
7469
-
* * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7469
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
7470
7470
* Swagger Name: AvaTaxClient
7471
7471
*
7472
7472
* @param int $companyId The ID of the company that defined these items.
@@ -7679,6 +7679,36 @@ public function upsertItemClassifications($companyId, $itemId, $model=null) {
* Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
7688
+
*
7689
+
* A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
7690
+
*
7691
+
* A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
7692
+
*
7693
+
* ### Security Policies
7694
+
*
7695
+
* * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
7696
+
* Swagger Name: AvaTaxClient
7697
+
*
7698
+
* @param int $companyId The ID of the company that this item belongs to.
7699
+
* @param int $itemId The ID of the item you want to update.
7700
+
* @param ItemParameterModel[] $model The item parameter object you want to upsert.
7701
+
* @return \stdClass
7702
+
*/
7703
+
public function upsertItemParameter($companyId, $itemId, $model=null) {
0 commit comments