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

FormMasterModel

Represents information about a tax form known to Avalara

Parameters
idOptional
integer

Unique ID number of this form master object

formTypeIdOptional
integer

The type of the form being submitted

taxFormCodeOptional
string

Unique tax form code representing this tax form

legacyReturnNameOptional
string

Legacy return name as known in the AvaFileForm table

taxFormNameOptional
string

Human readable form summary name

descriptionOptional
string

Description of this tax form

isEffectiveOptional
boolean

True if this form is available for use

countryOptional
string

ISO 3166 code of the country that issued this tax form

regionOptional
string

The region within which this form was issued

authorityNameOptional
string

Tax authority that issued the form

shortCodeOptional
string

DEPRECATED

dueDayOptional
integer

Day of the month when the form is due

delinquentDayOptional
integer

Day of the month on which the form is considered delinquent. Almost always the same as DueDay

fiscalYearStartMonthOptional
integer

Month of the year the state considers as the first fiscal month

hasMultiFrequenciesOptional
boolean

Can form support multi frequencies

isPOARequiredOptional
boolean

Does this tax authority require a power of attorney in order to speak to Avalara

isRegistrationRequiredOptional
boolean

True if this form requires that the customer register with the authority

hasMultiRegistrationMethodsOptional
boolean

Unused

hasSchedulesOptional
boolean

Unused

hasMultiFilingMethodsOptional
boolean

Unused

hasMultiPayMethodsOptional
boolean

Unused

isEFTRequiredOptional
boolean

Unused

isFilePayMethodLinkedOptional
boolean

Unused

mailingReceivedRuleIdOptional
integer

Unused

proofOfMailingIdOptional
integer

Unused

isNegAmountAllowedOptional
boolean

True if you can report a negative amount in a single jurisdiction on the form

allowNegativeOverallTaxOptional
boolean

True if the form overall can go negative

isNettingRequiredOptional
boolean

Unused

roundingMethodIdOptional
integer

Unused

vendorDiscountAnnualMaxOptional
number

Total amount of discounts that can be received by a vendor each year

versionsRequireAuthorityApprovalOptional
boolean

Unused

outletReportingMethodIdOptional
integer

Type of outlet reporting for this form

hasReportingCodesOptional
boolean

Unused

hasPrepaymentsOptional
boolean

Not sure if used

grossIncludesInterstateSalesOptional
boolean

Unused

grossIncludesTaxOptional
string

Unused

hasEfileFeeOptional
boolean

Unused

hasEpayFeeOptional
boolean

Unused

hasDependenciesOptional
boolean

Unused

requiredEfileTriggerOptional
string

Unused

requiredEftTriggerOptional
string

Unused

vendorDiscountEfileOptional
boolean

Unused

vendorDiscountPaperOptional
boolean

Unused

peerReviewedOptional
string

Unused

peerReviewedIdOptional
string

Unused

peerReviewedDateOptional
string

Unused

createdUserIdOptional
integer

ID of the Avalara user who created the form

createdDateOptional
string

Date when form was created

modifiedUserIdOptional
integer

ID of the Avalara user who modified the form

modifiedDateOptional
string

Date when form was modified

dorAddressMailToOptional
string

Mailing address of the department of revenue

dorAddress1Optional
string

Mailing address of the department of revenue

dorAddress2Optional
string

Mailing address of the department of revenue

dorAddressCityOptional
string

Mailing address of the department of revenue

dorAddressRegionOptional
string

Mailing address of the department of revenue

dorAddressPostalCodeOptional
string

Mailing address of the department of revenue

dorAddressCountryOptional
string

Mailing address of the department of revenue

zeroAddressMailToOptional
string

Mailing address to use when a zero dollar form is filed

zeroAddress1Optional
string

Mailing address to use when a zero dollar form is filed

zeroAddress2Optional
string

Mailing address to use when a zero dollar form is filed

zeroAddressCityOptional
string

Mailing address to use when a zero dollar form is filed

zeroAddressRegionOptional
string

Mailing address to use when a zero dollar form is filed

zeroAddressPostalCodeOptional
string

Mailing address to use when a zero dollar form is filed

zeroAddressCountryOptional
string

Mailing address to use when a zero dollar form is filed

amendedAddressMailToOptional
string

Mailing address to use when filing an amended return

amendedAddress1Optional
string

Mailing address to use when filing an amended return

amendedAddress2Optional
string

Mailing address to use when filing an amended return

amendedAddressCityOptional
string

Mailing address to use when filing an amended return

amendedAddressRegionOptional
string

Mailing address to use when filing an amended return

amendedAddressPostalCodeOptional
string

Mailing address to use when filing an amended return

amendedAddressCountryOptional
string

Mailing address to use when filing an amended return

onlineBackFilingOptional
boolean

Unused

onlineAmendedReturnsOptional
boolean

Unused

prepaymentFrequencyOptional
string

--Need Further Clarification

outletLocationIdentifiersRequiredOptional
boolean

Unused

listingSortOrderOptional
string

--Need Further Clarification

dorWebsiteOptional
string

Link to the state department of revenue website, if available

fileForAllOutletsOptional
boolean

--Need Further Clarification

paperFormsDoNotHaveDiscountsOptional
boolean

--Need Further Clarification

stackAggregationOptional
boolean

Internal behavior

roundingPrecisionOptional
string

--Need Further Clarification

inconsistencyToleranceOptional
string

--Need Further Clarification

effDateOptional
string

Date when this form became effective

endDateOptional
string

Date when this form expired

visibleToCustomersOptional
boolean

True if this form can be shown to customers

requiresOutletSetupOptional
boolean

True if this form requires that you set up outlets in the state

achCreditAllowedOptional
boolean

True if this state permits payment by ACH Credit

reportLevelOptional
string

Jurisdiction level of the state

postOfficeValidatedOptional
boolean

True if this form is verified filed via email

stackAggregationOptionOptional
string

Internal Avalara flag

sstBehaviorOptional
string

Internal Avalara flag

nonSstBehaviorOptional
string

Internal Avalara flag

dorPhoneNumberOptional
string

Phone number of the department of revenue

averageCheckClearDaysOptional
string

Unused

filterZeroRatedLineDetailsOptional
boolean

Unused

allowsBulkFilingAccountsOptional
boolean

Unused

bulkAccountInstructionLinkOptional
string

Unused

registrationIdFormatOptional
string

Unused

thresholdTriggerOptional
string

Unused

transactionSortingOptionOptional
string

Unused

contentReviewFrequencyIdOptional
integer

Unused

aliasForFormMasterIdOptional
string

Unused