AvaTax for VAT

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

FilingReturnModel

Filing Returns Model

Parameters
idOptional
integer

The unique ID number of this filing return.

filingRegionIdOptional
integer

The region id that this return belongs too

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.

resourceFileIdOptional
integer

The resourceFileId of the return. Will be null if not available.

taxAuthorityIdOptional
integer

Tax Authority ID of this return

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
filedDateOptional
string

The date the return was filed by Avalara.

startPeriodOptional
string

The start date of this return

endPeriodOptional
string

The end date of this return

salesAmountOptional
number

The sales amount.

filingTypeOptional
string

The filing type of the return.

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

The name of the form.

remitAmountOptional
number

The remittance amount of the return.

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.

taxableAmountOptional
number

The taxable amount.

taxAmountOptional
number

The tax amount.

collectAmountOptional
number

The amount collected by avalara for this return

taxDueAmountOptional
number

The tax due amount.

nonTaxableAmountOptional
number

The non-taxable amount.

nonTaxableDueAmountOptional
number

The non-taxable due amount.

consumerUseTaxAmountOptional
number

Consumer use tax liability during the period.

consumerUseTaxDueAmountOptional
number

Consumer use tax liability accrued during the period.

consumerUseNonTaxableAmountOptional
number

Consumer use non-taxable amount.

consumerUseTaxableAmountOptional
number

Consumer use taxable amount.

totalAdjustmentsOptional
number

Total amount of adjustments on this return

excludedSalesAmountOptional
number

The amount of sales excluded from the liability calculation

excludedNonTaxableAmountOptional
number

The amount of non-taxable sales excluded from the liability calculation

excludedTaxAmountOptional
number

The amount of tax excluded from the liability calculation

carryOverSalesAmountOptional
number

The amount of carry over sales applied to the liability calculation

carryOverNonTaxableAmountOptional
number

The amount of carry over non taxable sales applied to the liability calculation

carryOverTaxAmountOptional
number

The amount of carry over sales tax applied to the liability calculation

carryOverConsumerUseTaxAmountOptional
number

The amount of carry over consumer use tax applied to the liability calculation

taxAccrualAmountOptional
number

The total amount of total tax accrued in the current active period

salesAccrualAmountOptional
number

The total amount of sales accrued in the current active period

nonTaxableAccrualAmountOptional
number

The total amount of nontaxable sales accrued in the current active period

taxableAccrualAmountOptional
number

The total amount of taxable sales accrued in the current active period

salesTaxAccrualAmountOptional
number

The total amount of sales tax accrued in the current active period

sellersUseTaxAccrualAmountOptional
number

The total amount of sellers use tax accrued in the current active period

consumerUseTaxAccrualAmountOptional
number

The total amount of consumer use tax accrued in the current active period

consumerUseTaxableAccrualAmountOptional
number

The total amount of consumer use taxable sales accrued in the current active period

consumerUseNonTaxableAccrualAmountOptional
number

The total amount of consumer use non taxable sales accrued in the current active period

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.

accrualTypeOptional
string

Accrual type of the return

Enum: Filing, Accrual
monthOptional
integer

The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.

yearOptional
integer

The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.

typeOptional
string

The FilingTaskType for this return.

attachmentsOptional
array

The attachments for this return.

excludedCarryOverCreditsOptional
FilingReturnCreditModel

The excluded carry over credit documents

appliedCarryOverCreditsOptional
FilingReturnCreditModel

The applied carry over credit documents

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.

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.