AvaTax for VAT

Overview API

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

NoticeModel

Represents a letter received from a tax authority regarding tax filing. These letters often have the warning "Notice" printed at the top, which is why they are called "Notices".

Parameters

idRequired

integer

The unique ID number of this notice.

companyIdRequired

integer

The unique ID number of the company to which this notice belongs.

statusIdRequired

integer

The status id of the notice

statusOptional

string

The status of the notice

receivedDateRequired

string

The received date of the notice

closedDateOptional

string

The closed date of the notice

totalRemitOptional

number

The total remmitance amount for the notice

customerTypeIdRequired

string

NoticeCustomerTypeID can be retrieved from the definitions API

Enum: AvaTaxReturns, StandAlone, Strategic, SST, TrustFile, PWC, HudsonGroup, MRA, None

countryRequired

string

Name or ISO 3166 code identifying the country that sent this notice.

This field supports many different country identifiers:

Two character ISO 3166 codes
Three character ISO 3166 codes
Fully spelled out names of the country in ISO supported languages
Common alternative spellings for many countries

For a full list of all supported codes and names, please see the Definitions API ListCountries.

regionRequired

string

Name or ISO 3166 code identifying the region within the country that sent this notice.

This field supports many different region identifiers:

Two and three character ISO 3166 region codes
Fully spelled out names of the region in ISO supported languages
Common alternative spellings for many regions

For a full list of all supported codes and names, please see the Definitions API ListRegions.

taxAuthorityIdOptional

integer

The tax authority id of the notice

filingFrequencyOptional

string

The filing frequency of the notice

Enum: Monthly, Quarterly, SemiAnnually, Annually, Bimonthly, Occasional, InverseQuarterly, Weekly

filingTypeIdOptional

string

The filing type of the notice

Enum: ElectronicReturn, PaperReturn, ReturnNotFiled, EFTPaper, SER, TrustfileEdi, UploadFile, PaperManual, CertCapture, SignatureReady

ticketReferenceNoOptional

string

The ticket reference number of the notice

ticketReferenceUrlOptional

string

The ticket reference url of the notice

salesForceCaseOptional

string

The sales force case of the notice

salesForceCaseUrlOptional

string

The URL to the sales force case

taxPeriodRequired

string

The tax period of the notice

reasonIdRequired

integer

The notice reason id

reasonOptional

string

The notice reason

typeIdOptional

integer

The tax notice type id

typeOptional

string

The tax notice type description

customerFundingOptionIdOptional

string

The notice customer funding options

Enum: Pull, Wire

priorityIdRequired

string

The priority of the notice

Enum: ImmediateAttentionRequired, High, Normal, Low

customerCommentOptional

string

Comments from the customer on this notice

hideFromCustomerRequired

boolean

Indicator to hide from customer

expectedResolutionDateOptional

string

Expected resolution date of the notice

showResolutionDateToCustomerRequired

boolean

Indicator to show customer this resolution date

closedByUserIdOptional

integer

The unique ID number of the user that closed the notice

createdByUserNameOptional

string

The user who created the notice

modifiedUserNameOptional

string

The user who modified the notice

closedByUserNameOptional

string

The user who closed the notice

ownedByUserIdOptional

integer

The unique ID number of the user that owns the notice

descriptionOptional

string

The description of the notice

revenueContactIdOptional

integer

The id of the revenue contact

complianceContactIdOptional

integer

The id of the compliance contact

taxFormCodeRequired

string

The tax form code of the notice

documentReferenceOptional

string

The document reference of the notice

jurisdictionNameOptional

string

The jurisdiction name of the notice

jurisdictionTypeOptional

string

The jurisdiction type of the notice

commentsOptional

array

Additional comments on the notice

financesOptional

array

Finance details of the notice

responsibilityOptional

array

Notice Responsibility Details

rootCauseOptional

array

Notice Root Cause Details

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.

registrationIdOptional

string

The registration id of the notice