AvaTax

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

MultiTaxFilingReturnModel

Filing Returns Model

Parameters
idOptional
integer

The unique ID number of this filing return.

filingCalendarIdOptional
integer

The unique ID number of the filing calendar associated with this return.

registrationIdOptional
string

The registration ID from the return's filing calendar.

statusOptional
string

The current status of the filing return.

Enum: PendingApproval, Dirty, ApprovedToFile, PendingFiling, PendingFilingOnBehalf, Filed, FiledOnBehalf, ReturnAccepted, ReturnAcceptedOnBehalf, PaymentRemitted, Voided, PendingReturn, PendingReturnOnBehalf, DoNotFile, ReturnRejected, ReturnRejectedOnBehalf, ApprovedToFileOnBehalf, FiledByCustomer
filingFrequencyOptional
string

The filing frequency of the return.

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

The filing type of the return.

Enum: PaperReturn, ElectronicReturn, SER, EFTPaper, PhonePaper, SignatureReady, EfileCheck
formNameOptional
string

The name of the form.

formCodeOptional
string

The unique code of the form.

taxFormCodeOptional
string

The unique code of the form, prefixed by the country code.

descriptionOptional
string

A description for the return.

taxAuthorityIdOptional
integer

Tax Authority ID of this return

filedDateOptional
string

The date the return was filed by Avalara.

accrualTypeOptional
string

Accrual type of the return

Enum: Filing, Accrual
startPeriodOptional
string

The start date of this return

endPeriodOptional
string

The end date of this return

typeOptional
string

The FilingTaskType for this return.

liabilityCurrencyCodeOptional
string

The three-character liability currency code.

filingCalendarCurrencyCodeOptional
string

The three-character filing calendar currency code for this return. For example if country is 'US' then currency is 'USD'. Similarly, if country is 'CA' then currency is 'CAD', etc.

canUnlockOptional
boolean

Can the return be unlocked or not.

returnTaxSummaryOptional
FilingsTaxSummaryModel

A summary of all taxes compbined for this period

returnTaxDetailsOptional
array

A detailed breakdown of the taxes in this filing

excludedCarryOverCreditsOptional
FilingReturnCreditModel

The excluded carry over credit documents

appliedCarryOverCreditsOptional
FilingReturnCreditModel

The applied carry over credit documents

totalAdjustmentsOptional
number

Total amount of adjustments on this return

adjustmentsOptional
array

The Adjustments for this return.

totalAugmentationsOptional
number

Total amount of augmentations on this return

augmentationsOptional
array

The Augmentations for this return.

totalPaymentsOptional
number

Total amount of payments on this return

paymentsOptional
array

The payments for this return.

attachmentsOptional
array

The attachments for this return.