AvaTax for VAT

OverviewAPI
Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

ItemModel

Represents an item in your company's product catalog.

This model is used in the following APIs:

Parameters
idRequired
integer

The unique ID number of this item.

companyIdOptional
integer

The unique ID number of the company that owns this item.

itemCodeRequired
string

A unique code representing this item.

taxCodeIdOptional
integer

The unique ID number of the tax code that is applied when selling this item. When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values.

taxCodeOptional
string

The unique code string of the Tax Code that is applied when selling this item. When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values.

descriptionRequired
string

A friendly description of this item in your product catalog.

itemGroupOptional
string

A way to group similar items.

categoryOptional
string

A category of product

createdDateOptional
string

The date when this record was created.

createdUserIdOptional
integer

The User ID of the user who created this record.

modifiedDateOptional
string

The date/time when this record was last modified.

modifiedUserIdOptional
integer

The user ID of the user who last modified this record.

sourceOptional
string

Source of creation of this.

sourceEntityIdOptional
string

The unique identifier of this item at the source

itemTypeOptional
string

Type of item

upcOptional
string

Universal unique code for item

Deprecated - As of 6/25/2024, this field is deprecated. Instead of using this field, you can pass this value as a parameter. The parameter name is UPC.

summaryOptional
string

Long Summary for Item

Deprecated - As of 6/25/2024, this field is deprecated. Instead of using this field, you can pass this value as a parameter. The parameter name is Summary.

classificationsOptional
array

List of classifications that belong to this item. A single classification consists of a productCode and a systemCode for a particular item.

Please note: taxCode (ProductCode for SystemCode AVATAXCODE) is being removed from classifications. You can still find it in the taxCode field.

parametersOptional
array

List of item parameters.

customParametersOptional
array

List of item custom parameters

tagsOptional
array

List of item tags.

propertiesOptional
object

Additional key-description of the product.

itemStatusOptional
array

List of item status

taxCodeRecommendationStatusOptional
TaxCodeRecommendationStatusOutputModel

Item tax code recommendation status

taxCodeRecommendationsOptional
array

Item tax code recommendations

taxCodeDetailsOptional
ItemTaxCodeDetailsOutputModel

taxCode details for the item

hsCodeClassificationStatusOptional
array

List of item parameters

imageOptional
ItemImageDetailsModel

Item image of an item