Exemption Certificate Management

OverviewAPIMCPIntegration guides
ECM (AvaTax) API
CertCapture RESTful APIs

FilingRequestDataModel

Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.

Parameters
companyReturnIdOptional
integer

The company return ID if requesting an update.

returnNameOptional
string

DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use taxFormCode instead. The legacy return name of the requested calendar.

taxFormCodeOptional
string

The Avalara standard tax form code of the tax form for this filing calendar. The first two characters of the tax form code are the ISO 3166 country code of the country that issued this form.

filingFrequencyIdRequired
string

The filing frequency of the request

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

State registration ID of the company requesting the filing calendar.

monthsRequired
integer

The months of the request

fiscalYearStartMonthOptional
integer

The start period of a fiscal year for this form/company

taxTypeIdOptional
string

The type of tax to report on this return.

Enum: E, Lodging, Bottle, RentToOwn, BikeTax, LandedCost, CheckoutBag, Alcohol, Amusement, Hospitality, RentalLeasing, GrossReceipts, Mattress, Lumber, Paint, Tires, EI, All, BothSalesAndUseTax, ConsumerUseTax, ConsumersUseAndSellersUseTax, ConsumerUseAndSalesTax, Fee, VATInputTax, LightBulbs, Meals, VATNonrecoverableInputTax, VATOutputTax, PIF, Rental, SalesTax, UseTax, EWaste, Batteries
locationCodeOptional
string

Location code of the request

effDateRequired
string

Filing cycle effective date of the request

endDateOptional
string

Filing cycle end date of the request

isCloneOptional
boolean

Flag if the request is a clone of a current filing calendar

autoLockOverrideDayOptional
integer

Auto Lock Override Day

countryOptional
string

The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.

regionOptional
string

The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.

taxAuthorityIdOptional
integer

The tax authority id of the return

taxAuthorityNameOptional
string

The tax authority name on the return

answersOptional
array

Filing question answers