AvaTax for VAT
FilingCalendarModel
Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.
The unique ID number of this filing calendar.
The unique ID number of the company to which this filing calendar belongs.
DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use taxFormCode instead.
The legacy return name of the tax form to file.
Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar.
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.
Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar.
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.
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.
The start period of a fiscal year for this form/company
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release. If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
The frequency on which this tax form is filed.
A 16-bit bitmap containing a 1 for each month when the return should be filed.
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The first line of the mailing address that will be used when filling out this tax return.
DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The second line of the mailing address that will be used when filling out this tax return. Please note that some tax forms do not support multiple address lines.
DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The city name of the mailing address that will be used when filling out this tax return.
DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The state, region, or province of the mailing address that will be used when filling out this tax return.
DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The postal code or zip code of the mailing address that will be used when filling out this tax return.
DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The two character ISO-3166 country code of the mailing address that will be used when filling out this tax return.
The first line of the mailing address that will be used when filling out this tax return.
The second line of the mailing address that will be used when filling out this tax return. Please note that some tax forms do not support multiple address lines.
The city name of the mailing address that will be used when filling out this tax return.
Name or ISO 3166 code identifying the region of the mailing address that will be used when filling out this tax return.
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.
The postal code or zip code of the mailing address that will be used when filling out this tax return.
Name or ISO 3166 code identifying the country of the mailing address that will be used when filling out this tax return.
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.
The phone number to be used when filing this return.
DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release. Special filing instructions to be used when filing this return. Please note that requesting special filing instructions may incur additional costs.
The legal entity name to be used when filing this return.
The earliest date for the tax period when this return should be filed. This date specifies the earliest date for tax transactions that should be reported on this filing calendar. Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February.
The last date for the tax period when this return should be filed. This date specifies the last date for tax transactions that should be reported on this filing calendar. Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February.
The method to be used when filing this return.
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
If you are required to prepay a percentage of taxes for future periods, please specify the percentage in whole numbers; for example, the value 90 would indicate 90%.
Determines if a prepayment is required for this filing calendar
If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here.
DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward. The type of tax to report on this return.
The list of tax types to report on this return.
DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release. Internal filing notes.
Custom filing information field for Alabama.
Custom filing information field for Alabama.
Custom filing information field for Maine.
Custom filing information field for Iowa.
Custom filing information field for Connecticut.
Custom filing information field. Leave blank.
Custom filing information field. Leave blank.
Custom filing information field. Leave blank.
Custom filing information field. Leave blank.
Custom filing information field. Leave blank.
Custom filing information field. Leave blank.
The unique ID of the tax authority of this return.
The name of the tax authority of this return.
The type description of the tax authority of this return.
The date when this record was created.
The User ID of the user who created this record.
The date/time when this record was last modified.
The user ID of the user who last modified this record.
User name of bulk account.
The bulk account site code.
The status of the bulk account's validation.
CompanyReturn settings for complext filing calendar
Auto Lock Override Day
The three-character currency code according to country. For example if country is 'US' then currency is 'USD'. Similarly, if country is 'CA' then currency is 'CAD', etc.