Package net.avalara.avatax.rest.client.models

package net.avalara.avatax.rest.client.models

Related Packages

Package	Description
net.avalara.avatax.rest.client
net.avalara.avatax.rest.client.enums
net.avalara.avatax.rest.client.serializer

Classes

Class	Description
AccountConfigurationModel	Represents one configuration setting for this account
AccountLicenseKeyModel	An account user who is permitted to use AvaTax.
AccountMigrationStatusModel	An AvaTax account.
AccountModel	An AvaTax account.
ACHEntryDetailModel	An edit to be made on a filing calendar.
ActivateAccountModel	Represents a request to activate an account by reading and accepting its terms and conditions.
AddressesModel	Information about all the addresses involved in this transaction.
AddressInfo	Represents a base address element.
AddressLocationInfo	Represents an address to resolve.
AddressResolutionModel	Address Resolution Model
AddressValidationInfo	TextCase info for input address
AddTransactionLineModel	Model to add specific lines to exising transaction
AdjustMultiDocumentModel	Replace an existing MultiDocument transaction recorded in AvaTax with a new one.
AdjustTransactionModel	Replace an existing transaction recorded in AvaTax with a new one.
AdvancedRuleCustomerDataSchemaModel	Model for retrieving customer data schema
AdvancedRuleExecutionModel	Model representing an execution of an advanced rule for a company
AdvancedRuleExecutionOrderModel	Model for updating rule execution order
AdvancedRuleFullDetailsModel	Model for Advanced Rules when full details are requested
AdvancedRuleLookupFileModel	Model representing a lookup file for a company
AdvancedRuleModel	A generic global advanced rule encapsulating a script
AdvancedRuleScriptModel	Represents an advanced rule script
AdvancedRuleTableModel	Represents an advanced rule table
AdvancedRuleVisibilityModel	Model for toggling visibility of an advanced rule for an account
AgeVerifyRequest	The Request for the /ageVerification/verify endpoint.
AgeVerifyResult	The Result of a call to the /ageVerification/verify endpoint.
ApproveAdvancedRuleModel	Model for changing the approved status of an advanced rule
ApproveFilingsModel	Approve a set of filings.
AuditEvent
AuditModel	Provides detailed information about an API call.
AuditMultiDocumentModel	Information about a previously created MultiDocument transaction
AuditTransactionModel	Information about a previously created transaction
AvaFileFormModel	Represents information about a tax form known to Avalara
AvailableCycleModel	Available Cycle object
AvaTaxMessage	Informational or warning messages returned by AvaTax with a transaction
BatchAdjustTransactionModel	Replace an existing transaction recorded in AvaTax with a new one.
BatchFileModel	Represents one file in a batch upload.
BatchModel	Represents a batch of uploaded documents.
BatchVoidTransactionModel	A request to void a previously created transaction.
BulkLockTransactionModel	Bulk lock documents model
BulkLockTransactionResult	Returns information about transactions that were locked
CappedFetchResult
CertExpressInvitationModel	Represents an invitation for a customer to use CertExpress to self-report their own certificates.
CertExpressInvitationStatusModel	Represent what is the current status of certificate request
CertificateAttributeModel	A certificate attribute can be thought of as a feature or flag that is applied to a certificate.
CertificateModel	A certificate is a document stored in either AvaTax Exemptions or CertCapture.
CertificateTaxCodeModel	Represents a tax code used by the CertCapture process
ChangeTransactionCodeModel	Settle this transaction with your ledger by verifying its amounts.
ClassificationModel	Represents a classification for a given item.
ClassificationParameterUsageMapModel	usage of system defined parameters.
CommitMultiDocumentModel	Commit this MultiDocument object so that all transactions within it can be reported on a tax filing.
CommitTransactionModel	Commit this transaction as permanent so that it can be reported on a tax filing.
CommunicationsTransactionTypeModel	Represents information about a type of telecommunications transaction
CommunicationsTSPairModel	Represents a transaction/service type pair for telecommunications tax
CompanyAddress	Company Address Information
CompanyConfigurationModel	Represents one configuration setting for this company
CompanyDistanceThresholdModel	A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries.
CompanyInitializationModel	Company Initialization Model
CompanyModel	A company or business entity.
CompanyParameterDetailModel	Represents a parameter associated with a company.
CompanyReturnSettingModel
CompanyUserDefinedFieldModel
ComplianceAggregatedTaxRateModel	A model for aggregated rates.
ComplianceJurisdictionModel	Model for distinct jurisdictions.
ComplianceJurisdictionRateModel	A flattened model for jurisdictions and rates.
ComplianceTaxRateModel	The tax rate model.
ContactModel	A contact person for a company.
CoordinateInfo	Coordinate Info
CoverLetterModel	The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates.
CreateCertExpressInvitationModel	Represents an invitation for a customer to use CertExpress to self-report their own certificates.
CreateECommerceTokenInputModel	A model used to initialize a new CertCapture eCommerce token.
CreateMultiCompanyTransactionModel	Create a multi company transaction
CreateMultiDocumentModel	A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.
CreateNoticeResponsibilityTypeModel	Model to create a new tax notice responsibility type.
CreateNoticeRootCauseTypeModel	Model to create a new tax notice root cause type.
CreateOrAdjustTransactionModel	Create or adjust transaction model
CreateTransactionBatchRequestModel	Represents a create transaction batch request model.
CreateTransactionBatchResponseModel	Represents a create transaction batch response model.
CreateTransactionModel	Create a transaction
CurrencyModel	Represents an ISO 4217 currency code used for designating the currency of a transaction.
CustomerAttributeModel	A Customer's linked attribute denoting what features applied to the customer.
CustomerModel	Represents a customer to whom you sell products and/or services.
CustomerSupplierCountryParamModel	Represents a parameter associated with a company.
CustomerSupplierModel	Represents a parameter associated with a company.
CustomFieldModel	A custom field provides extra information about a customer or certificate.
CycleAddOptionModel	Model with options for adding a new filing calendar
CycleEditOptionModel	Model with options for actual filing calendar output based on user edits to filing calendar.
CycleExpireModel	Cycle Safe Expiration results.
CycleExpireOptionModel	Options for expiring a filing calendar.
CycleSafeEditRequestModel	Options for expiring a filing calendar.
CycleSafeFilingCalendarEditModel	Filing Calendar Edit
CycleSafeOptionResultModel	CycleSafe Option Result
DataSourceModel	Data source object
DeclareNexusByAddressModel	Use this object to provide an address and date range where your company does business.
DeleteErrorTransactionRequestModel	Single error transaction delete request
DeleteErrorTransactionResponseModel	Response model of a single error transaction delete
DeleteErrorTransactionsRequestModel	Request model for when a user is deleting multiple error transaction
DeleteErrorTransactionsResponseModel	Response model of error transaction batch delete
DenormalizedJurisModel	Represents information about a single legal taxing jurisdiction within a specific Avalara tax region.
DeterminationFactorModel	This object represents a single determination factor for a line that is being inspected through the InspectLine API.
EcmsDetailModel	Represents an ECMS record, used internally by AvaTax to track information about exemptions.
EcmsDetailTaxCodeModel
EcmsModel	Exempt certificate
ECommerceTokenOutputModel	The resource model returned by the ECommerceTokenController's endpoints.
EntityUseCodeModel	Represents a code describing the intended use for a product that may affect its taxability
ErrorCodeOutputModel	Model that has the matching count for an errorcode
ErrorDetail
ErrorDetails	Message Object
ErrorInfo	Information about the error that occurred
ErrorResult	Helper function for throwing known error response
ErrorTransactionModelBase	Base model class for single error transaction delete request
ErrorTransactionOutputModel	Error Transaction Model
ExemptionReasonModel	An exemption reason defines why a certificate allows a customer to be exempt for purposes of tax calculation.
ExemptionStatusModel	Indicates the customer's exemption status in a specific country and region.
ExportDocumentLineModel	An input model for executing a report detailed to the document line level
ExposureZoneModel	Information about a physical area or zone in which a certificate can apply.
FileContentResult
FiledReturnModel	Filing Returns Model
FilingAdjustmentModel	A model for return adjustments.
FilingAnswer
FilingAnswerModel
FilingAttachmentModel	An attachment associated with a filing return
FilingAugmentationModel	A model for return augmentations.
FilingCalendarEditModel	An edit to be made on a filing calendar.
FilingCalendarModel	Represents a commitment to file a tax return on a recurring basis.
FilingFrequencyModel	FilingFrequency Model
FilingModel	Represents a listing of all tax calculation data for filings and for accruing to future filings.
FilingPaymentModel	A model for return payments.
FilingRegionModel	Regions
FilingRequestDataModel	Represents a commitment to file a tax return on a recurring basis.
FilingRequestModel	Represents a commitment to file a tax return on a recurring basis.
FilingReturnCreditModel	An attachment associated with a filing return
FilingReturnModel	Filing Returns Model
FilingReturnModelBasic	Filing Returns Model
FilingsCheckupAuthorityModel	Cycle Safe Expiration results.
FilingsCheckupModel	Results of the Worksheet Checkup report
FilingsCheckupSuggestedFormModel	Worksheet Checkup Report Suggested Form Model
FilingStatusChangeModel	Represents a change request for filing status for a company
FilingsTaxDetailsModel	Represents a listing of all tax calculation data for filings and for accruing to future filings.
FilingsTaxSummaryModel	Represents a listing of all tax calculation data for filings and for accruing to future filings.
FirmClientLinkageInputModel	Account Linkage Input model
FirmClientLinkageOutputModel	Account Linkage output model
FormMasterModel	Represents information about a tax form known to Avalara
FreeTrialRequestModel	Represents a request for a free trial account for AvaTax.
FrequencyAvailableModel	Frequency Available object
FundingConfigurationModel	Status of an Avalara Managed Returns funding configuration for a company
FundingESignMethodReturn	Represents the current status of a funding ESign method
FundingInitiateModel
FundingStatusModel	Status of an Avalara Managed Returns funding configuration for a company
HsCodeModel	Describes an element in the harmonized tariff system.
InspectLineResponseModel	Response model used as output for InspectLine API.
InspectResponseModel	Response model used as output for InspectLine API.
InvoiceMessageModel	Represents a message to be displayed on an invoice.
IsoCountryModel	Represents an ISO 3166 recognized country
IsoLocalizedName	Represents a language-specific localized name of a particular geographic entity such as a country or a region.
IsoRegionModel	Represents a region, province, or state within a country
ItemBulkUploadInputModel	Represents a bulk upload input model.
ItemBulkUploadOutputModel	Represents a bulk upload response model.
ItemClassificationInputModel	Product classification input model.
ItemClassificationOutputModel	Product classification output model.
ItemModel	Represents an item in your company's product catalog.
ItemParameterModel	Represents a parameter associated with an item.
ItemSyncModel	An abridged item model used for syncing product catalogs with AvaTax.
ItemTagDetailModel	Represents a tag for an item in your company's product catalog.
ItemUploadErrorModel	Represents a item upload error model.
JurisdictionModel	Represents information about a single legal taxing jurisdiction
JurisdictionOverrideModel	Represents an override of tax jurisdictions for a specific address.
JurisdictionRateTypeTaxTypeMappingModel	Represents a Jurisdiction with applicable TaxType, TaxSubType and RateType.
LicenseKeyModel	Represents a license key for this account.
LineDetailSERCodeModel	SER code fixup
LineItemModel	Represents one line item in a transaction
LinkCertificatesModel	Represents a customer to whom you sell products and/or services.
LinkCustomersModel	Represents a customer to whom you sell products and/or services.
LocationModel	A location where this company does business.
LocationParameterModel	The parameter associated with a company location.
LocationQuestionModel	Information about questions that the local jurisdictions require for each location
LocationSettingModel	Represents the answer to one local jurisdiction question for a location.
LocationValidationModel	Tells you whether this location object has been correctly set up to the local jurisdiction's standards
LockTransactionModel	Commit this transaction as permanent
LoginVerificationInputModel	Represents a verification request using Skyscraper for a company
LoginVerificationOutputModel	This is the output model coming from skyscraper services
MarketplaceLocationModel	Marketplace Location Output model
MarketplaceModel	Marketplace Location Output model
Message
MrsCompanyModel	A company and account
MultiCompanyLineItemModel	Represents one line item in a multi company transaction
MultiDocumentLineItemModel	Represents one line item in a MultiDocument transaction
MultiDocumentModel	A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.
MultiTaxFilingModel	Represents a listing of all tax calculation data for filings and for accruing to future filings.
MultiTaxFilingRegionModel	Regions
MultiTaxFilingReturnModel	Filing Returns Model
NewAccountModel	Represents information about a newly created account
NewAccountRequestModel	Represents a request for a new account with Avalara for a new subscriber.
NewFirmClientAccountRequestModel	Represents a request for a new account with Avalara for a new Firm client.
NexusByAddressModel	Contains information about nexus jurisdictions that were declared as a result of a call to `DeclareNexusByAddress`.
NexusByTaxFormModel	Identifies all nexus that match a particular tax form
NexusModel	Represents a declaration of nexus within a particular taxing jurisdiction.
NexusParameterDetailModel	Represents a parameter associated with a nexus.
NexusSummaryModel	Nexus summary model
NexusTaxTypeGroupCountModel	Nexus tax type groupe with count
NexusTaxTypeGroupModel	Represents a group of tax types
NoticeCommentModel	Represents communication between Avalara and the company regarding the processing of a tax notice.
NoticeCustomerFundingOptionModel	Tax Authority Model
NoticeCustomerTypeModel	Tax Authority Model
NoticeFilingTypeModel	Tax Notice FilingType Model
NoticeFinanceModel	Represents estimated financial results from responding to a tax notice.
NoticeModel	Represents a letter received from a tax authority regarding tax filing.
NoticePriorityModel	Tax Notice Priority Model
NoticeReasonModel	Tax Notice Reason Model
NoticeResponsibilityDetailModel	NoticeResponsibility Model
NoticeResponsibilityModel	NoticeResponsibility Model
NoticeRootCauseDetailModel	NoticeRootCause Model
NoticeRootCauseModel	NoticeRootCause Model
NoticeStatusModel	Tax Notice Status Model
NoticeTypeModel	Tax Notice Type Model
NotificationModel	Represents a single notification.
OfferModel	Gets the response for the offer request
OriginalApiRequestResponseModel	Represents the exact API request and response from the original transaction API call, if available
ParameterModel	An extra property that can change the behavior of tax transactions.
ParameterUsageModel	usage of system defined parameters.
PasswordChangeModel	Password Change Model
PingResultModel	Ping Result Model
PointOfSaleDataRequestModel	Point-of-Sale Data Request Model
PoNumberModel	Represents a purchase order number for a transaction
PostalCodeModel	Represents a PostalCode and its associated data like: country, region, effective dates, etc.
PowerOfAttorneyCheckModel	Response when checking if a company has a POA on file with Avalara
PreferredProgramModel	A preferred program is a customs and/or duty program that can be used to handle cross-border transactions.
ProductClassificationSystemModel	Represents a product classification system.
ProductSystemCountryModel	Represents a System Country.
ProvisionStatusModel	Contains information about a company's exemption certificate status.
QueryRequestModel	Represents a complex query request to parse using query filter guidelines from Microsoft REST standards
RateModel	Indicates one element of a sales tax rate.
RateTypeModel	Rate type Model
RateTypesModel	Rate types Model
RebuildFilingsModel	Rebuild a set of filings.
ReconstructedApiRequestResponseModel	This model contains a reconstructed CreateTransaction request object that could potentially be used to recreate this transaction.
ReconstructedMultiDocumentModel	Contains information about the original API request and response that created a MultiDocument object.
RefreshECommerceTokenInputModel	A model used to request the refresh of a CertCapture eCommerce token.
RefundTransactionModel	Refund a committed transaction
RemoveTransactionLineModel	Model to specify lines to be removed
ReportModel	A model for displaying report task metadata
ReportParametersModel	The output model for report parameter definitions
requiredFilingCalendarDataFieldModel	Represents a verification request using Skyscraper for a company
ResetLicenseKeyModel	Represents a license key reset request.
ResourceFileDownloadResult	Represents everything downloaded from resource files
ResourceFileTypeModel	Resource File Type Model
ResourceFileUploadRequestModel	A request to upload a file to Resource Files
ResourceFileUploadResultModel	Encapsulates the result of uploading a file to the resource system
ReturnsParameterUsageModel	usage of system defined parameters for returns.
SecurityRoleModel	Represents a single security role.
SendSalesRequestModel	SendSales Request Model.
SetPasswordModel	Set Password Model
SettingModel	This object is used to keep track of custom information about a company.
SettleTransactionModel	Settle this transaction with your ledger by executing one or many actions against that transaction.
ShippingVerifyResult	The Response of the /shippingverify endpoint.
SkyscraperStatusModel	Represents a list of statuses of returns available in skyscraper
SubscriptionModel	Represents a service that this account has subscribed to.
SubscriptionTypeModel	Represents a service or a subscription type.
SyncItemsRequestModel	Represents a request to sync items.
SyncItemsResponseModel	The response returned after an item sync was requested.
TagsModel	Represents a tag for an item in your company's product catalog.
TaxAuthorityFormModel	Represents a form that can be filed with a tax authority.
TaxAuthorityInfo	Information about a tax authority relevant for an address.
TaxAuthorityModel	Tax Authority Model
TaxAuthorityTypeModel	Tax Authority Type Model
TaxCodeModel	Represents a tax code that can be applied to items on a transaction.
TaxCodeTypesModel	Information about Avalara-defined tax code types.
TaxDetailsByTaxSubType	Tax Details by Tax subtype
TaxDetailsByTaxType	Tax Details by Tax Type
TaxOverrideModel	Represents a tax override for a transaction
TaxRateModel	Contains information about the general tangible personal property sales tax rates for this jurisdiction.
TaxRegionJurisdictionModel	The tax region jurisdiction model.
TaxRegionModel	The tax region model.
TaxRuleModel	Represents a tax rule that changes the behavior of Avalara's tax engine for certain products and/or entity use codes in certain jurisdictions.
TaxRuleProductDetailModel	Represents a tax rule product detail that changes the behavior of Avalara's tax engine for certain tax rules.
TaxSubTypeModel	Represents a tax subtype
TaxTypeGroupModel	Represents a tax type group
TaxTypeModel	Represents a tax type
TransactionAddressModel	An address used within this transaction.
TransactionBatchItemModel	Represents a transaction batch item.
TransactionLineDetailModel	An individual tax detail element.
TransactionLineLocationTypeModel	Represents information about location types stored in a line
TransactionLineModel	One line item on this transaction.
TransactionLineParameterModel	Represents a transaction parameter.
TransactionLineTaxAmountByTaxTypeModel	Represents a transaction parameter.
TransactionLineUserDefinedFieldModel	User Defined fields/Flex Fields at Transaction Line level.
TransactionLocationTypeModel	Information about a location type
TransactionModel	This object represents a single transaction; for example, a sales invoice or purchase order.
TransactionParameterModel	Represents a transaction parameter.
TransactionReferenceFieldModel	Represents a fixup change
TransactionSummary	Summary information about an overall transaction.
TransactionUserDefinedFieldModel	User Defined fields/Flex Fields at Transaction level.
UnitOfBasisModel
UomModel	The "Unit of Measurement" model captures information about a type of measurement.
UPCModel	One Universal Product Code object as defined for your company.
UpdateCompanyLocationRemittanceModel	Expire a location without restriction then update with new remittance and dates.
UserEntitlementModel	User Entitlement Model
UserModel	An account user who is permitted to use AvaTax.
UsernameModel	Information about a username.
ValidatedAddressInfo	Represents a validated address
VerifyMultiDocumentModel	Verify that a MultiDocument object matches the information in your accounting system.
VerifyTransactionModel	Verify this transaction by matching it to values in your accounting system.
VoidTransactionModel	A request to void a previously created transaction
WorksheetDocument
WorksheetDocumentLine