Package net.avalara.avatax.rest.client.models

Class FilingCalendarModel

java.lang.Object

net.avalara.avatax.rest.client.models.FilingCalendarModel

public class FilingCalendarModel
extends Object

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

Constructor Summary

Constructors

Constructor	Description
FilingCalendarModel()

Method Summary

Modifier and Type	Method	Description
String	getAlAccessCode()	Getter for alAccessCode Custom filing information field for Alabama.
String	getAlSignOn()	Getter for alSignOn Custom filing information field for Alabama.
String	getBulkAccountId()	Getter for bulkAccountId User name of bulk account.
BulkAccountValidationStatus	getBulkAccountValidationStatus()	Getter for bulkAccountValidationStatus The status of the bulk account's validation.
String	getCity()	Getter for city DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
Integer	getCompanyId()	Getter for companyId The unique ID number of the company to which this filing calendar belongs.
String	getCountry()	Getter for country DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
Date	getCreatedDate()	Getter for createdDate The date when this record was created.
Integer	getCreatedUserId()	Getter for createdUserId The User ID of the user who created this record.
String	getCtReg()	Getter for ctReg Custom filing information field for Connecticut.
String	getCustomerFilingInstructions()	Getter for customerFilingInstructions DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
Date	getEffectiveDate()	Getter for effectiveDate The earliest date for the tax period when this return should be filed.
String	getEFilePassword()	Getter for eFilePassword If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
String	getEFileUsername()	Getter for eFileUsername If you file electronically, this is the username you use to log in to the tax authority's website.
String	getEmployerIdentificationNumber()	Getter for employerIdentificationNumber The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
Date	getEndDate()	Getter for endDate The last date for the tax period when this return should be filed.
FilingFrequencyId	getFilingFrequencyId()	Getter for filingFrequencyId The frequency on which this tax form is filed.
FilingTypeId	getFilingTypeId()	Getter for filingTypeId The method to be used when filing this return.
Integer	getFiscalYearStartMonth()	Getter for fiscalYearStartMonth The start period of a fiscal year for this form/company
BigDecimal	getFixedPrepaymentAmount()	Getter for fixedPrepaymentAmount If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here.
String	getFormCountry()	Getter for formCountry Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar.
String	getFormRegion()	Getter for formRegion Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar.
String	getIaBen()	Getter for iaBen Custom filing information field for Iowa.
Long	getId()	Getter for id The unique ID number of this filing calendar.
String	getInternalNotes()	Getter for internalNotes DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
String	getLegalEntityName()	Getter for legalEntityName The legal entity name to be used when filing this return.
String	getLine1()	Getter for line1 DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
String	getLine2()	Getter for line2 DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
String	getLocalRegistrationId()	Getter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.
String	getLocationCode()	Getter for locationCode If this calendar is for a location-specific tax return, specify the location code here.
String	getMailingAddressCity()	Getter for mailingAddressCity The city name of the mailing address that will be used when filling out this tax return.
String	getMailingAddressCountry()	Getter for mailingAddressCountry Name or ISO 3166 code identifying the country of the mailing address that will be used when filling out this tax return.
String	getMailingAddressLine1()	Getter for mailingAddressLine1 The first line of the mailing address that will be used when filling out this tax return.
String	getMailingAddressLine2()	Getter for mailingAddressLine2 The second line of the mailing address that will be used when filling out this tax return.
String	getMailingAddressPostalCode()	Getter for mailingAddressPostalCode The postal code or zip code of the mailing address that will be used when filling out this tax return.
String	getMailingAddressRegion()	Getter for mailingAddressRegion Name or ISO 3166 code identifying the region of the mailing address that will be used when filling out this tax return.
String	getMeBusinessCode()	Getter for meBusinessCode Custom filing information field for Maine.
Date	getModifiedDate()	Getter for modifiedDate The date/time when this record was last modified.
Integer	getModifiedUserId()	Getter for modifiedUserId The user ID of the user who last modified this record.
Short	getMonths()	Getter for months A 16-bit bitmap containing a 1 for each month when the return should be filed.
String	getOther1Name()	Getter for other1Name Custom filing information field.
String	getOther1Value()	Getter for other1Value Custom filing information field.
String	getOther2Name()	Getter for other2Name Custom filing information field.
String	getOther2Value()	Getter for other2Value Custom filing information field.
String	getOther3Name()	Getter for other3Name Custom filing information field.
String	getOther3Value()	Getter for other3Value Custom filing information field.
OutletTypeId	getOutletTypeId()	Getter for outletTypeId DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
String	getPaymentCurrency()	Getter for paymentCurrency Specify the ISO 4217 currency code for the currency to remit for this tax return.
String	getPhone()	Getter for phone The phone number to be used when filing this return.
String	getPostalCode()	Getter for postalCode DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
Boolean	getPrePaymentRequired()	Getter for prePaymentRequired Determines if a prepayment is required for this filing calendar
Integer	getPrepayPercentage()	Getter for prepayPercentage 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%.
String	getRegion()	Getter for region DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
String	getReturnName()	Getter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
ArrayList<CompanyReturnSettingModel>	getSettings()	Getter for settings CompanyReturn settings for complext filing calendar
String	getSiteCode()	Getter for siteCode The bulk account site code.
String	getStateRegistrationId()	Getter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.
Integer	getTaxAuthorityId()	Getter for taxAuthorityId The unique ID of the tax authority of this return.
String	getTaxAuthorityName()	Getter for taxAuthorityName The name of the tax authority of this return.
String	getTaxAuthorityType()	Getter for taxAuthorityType The type description of the tax authority of this return.
String	getTaxFormCode()	Getter for taxFormCode The Avalara standard tax form code of the tax form for this filing calendar.
MatchingTaxType	getTaxTypeId()	Getter for taxTypeId DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward.
ArrayList<String>	getTaxTypes()	Getter for taxTypes The list of tax types to report on this return.
void	setAlAccessCode(String value)	Setter for alAccessCode Custom filing information field for Alabama.
void	setAlSignOn(String value)	Setter for alSignOn Custom filing information field for Alabama.
void	setBulkAccountId(String value)	Setter for bulkAccountId User name of bulk account.
void	setBulkAccountValidationStatus(BulkAccountValidationStatus value)	Setter for bulkAccountValidationStatus The status of the bulk account's validation.
void	setCity(String value)	Setter for city DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
void	setCompanyId(Integer value)	Setter for companyId The unique ID number of the company to which this filing calendar belongs.
void	setCountry(String value)	Setter for country DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
void	setCreatedDate(Date value)	Setter for createdDate The date when this record was created.
void	setCreatedUserId(Integer value)	Setter for createdUserId The User ID of the user who created this record.
void	setCtReg(String value)	Setter for ctReg Custom filing information field for Connecticut.
void	setCustomerFilingInstructions(String value)	Setter for customerFilingInstructions DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
void	setEffectiveDate(Date value)	Setter for effectiveDate The earliest date for the tax period when this return should be filed.
void	setEFilePassword(String value)	Setter for eFilePassword If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
void	setEFileUsername(String value)	Setter for eFileUsername If you file electronically, this is the username you use to log in to the tax authority's website.
void	setEmployerIdentificationNumber(String value)	Setter for employerIdentificationNumber The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
void	setEndDate(Date value)	Setter for endDate The last date for the tax period when this return should be filed.
void	setFilingFrequencyId(FilingFrequencyId value)	Setter for filingFrequencyId The frequency on which this tax form is filed.
void	setFilingTypeId(FilingTypeId value)	Setter for filingTypeId The method to be used when filing this return.
void	setFiscalYearStartMonth(Integer value)	Setter for fiscalYearStartMonth The start period of a fiscal year for this form/company
void	setFixedPrepaymentAmount(BigDecimal value)	Setter for fixedPrepaymentAmount If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here.
void	setFormCountry(String value)	Setter for formCountry Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar.
void	setFormRegion(String value)	Setter for formRegion Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar.
void	setIaBen(String value)	Setter for iaBen Custom filing information field for Iowa.
void	setId(Long value)	Setter for id The unique ID number of this filing calendar.
void	setInternalNotes(String value)	Setter for internalNotes DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
void	setLegalEntityName(String value)	Setter for legalEntityName The legal entity name to be used when filing this return.
void	setLine1(String value)	Setter for line1 DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
void	setLine2(String value)	Setter for line2 DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
void	setLocalRegistrationId(String value)	Setter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.
void	setLocationCode(String value)	Setter for locationCode If this calendar is for a location-specific tax return, specify the location code here.
void	setMailingAddressCity(String value)	Setter for mailingAddressCity The city name of the mailing address that will be used when filling out this tax return.
void	setMailingAddressCountry(String value)	Setter for mailingAddressCountry Name or ISO 3166 code identifying the country of the mailing address that will be used when filling out this tax return.
void	setMailingAddressLine1(String value)	Setter for mailingAddressLine1 The first line of the mailing address that will be used when filling out this tax return.
void	setMailingAddressLine2(String value)	Setter for mailingAddressLine2 The second line of the mailing address that will be used when filling out this tax return.
void	setMailingAddressPostalCode(String value)	Setter for mailingAddressPostalCode The postal code or zip code of the mailing address that will be used when filling out this tax return.
void	setMailingAddressRegion(String value)	Setter for mailingAddressRegion Name or ISO 3166 code identifying the region of the mailing address that will be used when filling out this tax return.
void	setMeBusinessCode(String value)	Setter for meBusinessCode Custom filing information field for Maine.
void	setModifiedDate(Date value)	Setter for modifiedDate The date/time when this record was last modified.
void	setModifiedUserId(Integer value)	Setter for modifiedUserId The user ID of the user who last modified this record.
void	setMonths(Short value)	Setter for months A 16-bit bitmap containing a 1 for each month when the return should be filed.
void	setOther1Name(String value)	Setter for other1Name Custom filing information field.
void	setOther1Value(String value)	Setter for other1Value Custom filing information field.
void	setOther2Name(String value)	Setter for other2Name Custom filing information field.
void	setOther2Value(String value)	Setter for other2Value Custom filing information field.
void	setOther3Name(String value)	Setter for other3Name Custom filing information field.
void	setOther3Value(String value)	Setter for other3Value Custom filing information field.
void	setOutletTypeId(OutletTypeId value)	Setter for outletTypeId DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
void	setPaymentCurrency(String value)	Setter for paymentCurrency Specify the ISO 4217 currency code for the currency to remit for this tax return.
void	setPhone(String value)	Setter for phone The phone number to be used when filing this return.
void	setPostalCode(String value)	Setter for postalCode DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
void	setPrePaymentRequired(Boolean value)	Setter for prePaymentRequired Determines if a prepayment is required for this filing calendar
void	setPrepayPercentage(Integer value)	Setter for prepayPercentage 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%.
void	setRegion(String value)	Setter for region DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
void	setReturnName(String value)	Setter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
void	setSettings(ArrayList<CompanyReturnSettingModel> value)	Setter for settings CompanyReturn settings for complext filing calendar
void	setSiteCode(String value)	Setter for siteCode The bulk account site code.
void	setStateRegistrationId(String value)	Setter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.
void	setTaxAuthorityId(Integer value)	Setter for taxAuthorityId The unique ID of the tax authority of this return.
void	setTaxAuthorityName(String value)	Setter for taxAuthorityName The name of the tax authority of this return.
void	setTaxAuthorityType(String value)	Setter for taxAuthorityType The type description of the tax authority of this return.
void	setTaxFormCode(String value)	Setter for taxFormCode The Avalara standard tax form code of the tax form for this filing calendar.
void	setTaxTypeId(MatchingTaxType value)	Setter for taxTypeId DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward.
void	setTaxTypes(ArrayList<String> value)	Setter for taxTypes The list of tax types to report on this return.
String	toString()	Returns a JSON string representation of FilingCalendarModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FilingCalendarModel

public FilingCalendarModel()

Method Details

getId

public Long getId()

Getter for id The unique ID number of this filing calendar.

setId

public void setId(Long value)

Setter for id The unique ID number of this filing calendar.

getCompanyId

public Integer getCompanyId()

Getter for companyId The unique ID number of the company to which this filing calendar belongs.

setCompanyId

public void setCompanyId(Integer value)

Setter for companyId The unique ID number of the company to which this filing calendar belongs.

getReturnName

public String getReturnName()

Getter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead. The legacy return name of the tax form to file.

setReturnName

public void setReturnName(String value)

Setter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead. The legacy return name of the tax form to file.

getFormCountry

public String getFormCountry()

Getter for formCountry 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`.

setFormCountry

public void setFormCountry(String value)

Setter for formCountry 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`.

getFormRegion

public String getFormRegion()

Getter for formRegion 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`.

setFormRegion

public void setFormRegion(String value)

Setter for formRegion 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`.

getTaxFormCode

public String getTaxFormCode()

Getter for taxFormCode 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.

setTaxFormCode

public void setTaxFormCode(String value)

Setter for taxFormCode 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.

getFiscalYearStartMonth

public Integer getFiscalYearStartMonth()

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

setFiscalYearStartMonth

public void setFiscalYearStartMonth(Integer value)

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

getLocationCode

public String getLocationCode()

Getter for locationCode If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

setLocationCode

public void setLocationCode(String value)

Setter for locationCode If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

getOutletTypeId

public OutletTypeId getOutletTypeId()

Getter for outletTypeId 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.

setOutletTypeId

public void setOutletTypeId(OutletTypeId value)

Setter for outletTypeId 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.

getPaymentCurrency

public String getPaymentCurrency()

Getter for paymentCurrency 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".

setPaymentCurrency

public void setPaymentCurrency(String value)

Setter for paymentCurrency 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".

getFilingFrequencyId

public FilingFrequencyId getFilingFrequencyId()

Getter for filingFrequencyId The frequency on which this tax form is filed.

setFilingFrequencyId

public void setFilingFrequencyId(FilingFrequencyId value)

Setter for filingFrequencyId The frequency on which this tax form is filed.

getMonths

public Short getMonths()

Getter for months A 16-bit bitmap containing a 1 for each month when the return should be filed.

setMonths

public void setMonths(Short value)

Setter for months A 16-bit bitmap containing a 1 for each month when the return should be filed.

getStateRegistrationId

public String getStateRegistrationId()

Getter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.

setStateRegistrationId

public void setStateRegistrationId(String value)

Setter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.

getLocalRegistrationId

public String getLocalRegistrationId()

Getter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.

setLocalRegistrationId

public void setLocalRegistrationId(String value)

Setter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.

getEmployerIdentificationNumber

public String getEmployerIdentificationNumber()

Getter for employerIdentificationNumber The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.

setEmployerIdentificationNumber

public void setEmployerIdentificationNumber(String value)

Setter for employerIdentificationNumber The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.

getLine1

public String getLine1()

Getter for line1 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.

setLine1

public void setLine1(String value)

Setter for line1 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.

getLine2

public String getLine2()

Getter for line2 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.

setLine2

public void setLine2(String value)

Setter for line2 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.

getCity

public String getCity()

Getter for city 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.

setCity

public void setCity(String value)

Setter for city 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.

getRegion

public String getRegion()

Getter for region 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.

setRegion

public void setRegion(String value)

Setter for region 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.

getPostalCode

public String getPostalCode()

Getter for postalCode 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.

setPostalCode

public void setPostalCode(String value)

Setter for postalCode 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.

getCountry

public String getCountry()

Getter for country 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.

setCountry

public void setCountry(String value)

Setter for country 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.

getMailingAddressLine1

public String getMailingAddressLine1()

Getter for mailingAddressLine1 The first line of the mailing address that will be used when filling out this tax return.

setMailingAddressLine1

public void setMailingAddressLine1(String value)

Setter for mailingAddressLine1 The first line of the mailing address that will be used when filling out this tax return.

getMailingAddressLine2

public String getMailingAddressLine2()

Getter for mailingAddressLine2 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.

setMailingAddressLine2

public void setMailingAddressLine2(String value)

Setter for mailingAddressLine2 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.

getMailingAddressCity

public String getMailingAddressCity()

Getter for mailingAddressCity The city name of the mailing address that will be used when filling out this tax return.

setMailingAddressCity

public void setMailingAddressCity(String value)

Setter for mailingAddressCity The city name of the mailing address that will be used when filling out this tax return.

getMailingAddressRegion

public String getMailingAddressRegion()

Getter for mailingAddressRegion 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`.

setMailingAddressRegion

public void setMailingAddressRegion(String value)

Setter for mailingAddressRegion 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`.

getMailingAddressPostalCode

public String getMailingAddressPostalCode()

Getter for mailingAddressPostalCode The postal code or zip code of the mailing address that will be used when filling out this tax return.

setMailingAddressPostalCode

public void setMailingAddressPostalCode(String value)

Setter for mailingAddressPostalCode The postal code or zip code of the mailing address that will be used when filling out this tax return.

getMailingAddressCountry

public String getMailingAddressCountry()

Getter for mailingAddressCountry 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`.

setMailingAddressCountry

public void setMailingAddressCountry(String value)

Setter for mailingAddressCountry 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`.

getPhone

public String getPhone()

Getter for phone The phone number to be used when filing this return.

setPhone

public void setPhone(String value)

Setter for phone The phone number to be used when filing this return.

getCustomerFilingInstructions

public String getCustomerFilingInstructions()

Getter for customerFilingInstructions 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.

setCustomerFilingInstructions

public void setCustomerFilingInstructions(String value)

Setter for customerFilingInstructions 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.

getLegalEntityName

public String getLegalEntityName()

Getter for legalEntityName The legal entity name to be used when filing this return.

setLegalEntityName

public void setLegalEntityName(String value)

Setter for legalEntityName The legal entity name to be used when filing this return.

getEffectiveDate

public Date getEffectiveDate()

Getter for effectiveDate 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.

setEffectiveDate

public void setEffectiveDate(Date value)

Setter for effectiveDate 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.

getEndDate

public Date getEndDate()

Getter for endDate 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.

setEndDate

public void setEndDate(Date value)

Setter for endDate 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.

getFilingTypeId

public FilingTypeId getFilingTypeId()

Getter for filingTypeId The method to be used when filing this return.

setFilingTypeId

public void setFilingTypeId(FilingTypeId value)

Setter for filingTypeId The method to be used when filing this return.

getEFileUsername

public String getEFileUsername()

Getter for eFileUsername If you file electronically, this is the username you use to log in to the tax authority's website.

setEFileUsername

public void setEFileUsername(String value)

Setter for eFileUsername If you file electronically, this is the username you use to log in to the tax authority's website.

getEFilePassword

public String getEFilePassword()

Getter for eFilePassword If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

setEFilePassword

public void setEFilePassword(String value)

Setter for eFilePassword If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

getPrepayPercentage

public Integer getPrepayPercentage()

Getter for prepayPercentage 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%.

setPrepayPercentage

public void setPrepayPercentage(Integer value)

Setter for prepayPercentage 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%.

getPrePaymentRequired

public Boolean getPrePaymentRequired()

Getter for prePaymentRequired Determines if a prepayment is required for this filing calendar

setPrePaymentRequired

public void setPrePaymentRequired(Boolean value)

Setter for prePaymentRequired Determines if a prepayment is required for this filing calendar

getFixedPrepaymentAmount

public BigDecimal getFixedPrepaymentAmount()

Getter for fixedPrepaymentAmount If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here.

setFixedPrepaymentAmount

public void setFixedPrepaymentAmount(BigDecimal value)

Setter for fixedPrepaymentAmount If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here.

getTaxTypeId

public MatchingTaxType getTaxTypeId()

Getter for taxTypeId DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward. The type of tax to report on this return.

setTaxTypeId

public void setTaxTypeId(MatchingTaxType value)

Setter for taxTypeId DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward. The type of tax to report on this return.

getTaxTypes

public ArrayList<String> getTaxTypes()

Getter for taxTypes The list of tax types to report on this return.

setTaxTypes

public void setTaxTypes(ArrayList<String> value)

Setter for taxTypes The list of tax types to report on this return.

getInternalNotes

public String getInternalNotes()

Getter for internalNotes 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.

setInternalNotes

public void setInternalNotes(String value)

Setter for internalNotes 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.

getAlSignOn

public String getAlSignOn()

Getter for alSignOn Custom filing information field for Alabama.

setAlSignOn

public void setAlSignOn(String value)

Setter for alSignOn Custom filing information field for Alabama.

getAlAccessCode

public String getAlAccessCode()

Getter for alAccessCode Custom filing information field for Alabama.

setAlAccessCode

public void setAlAccessCode(String value)

Setter for alAccessCode Custom filing information field for Alabama.

getMeBusinessCode

public String getMeBusinessCode()

Getter for meBusinessCode Custom filing information field for Maine.

setMeBusinessCode

public void setMeBusinessCode(String value)

Setter for meBusinessCode Custom filing information field for Maine.

getIaBen

public String getIaBen()

Getter for iaBen Custom filing information field for Iowa.

setIaBen

public void setIaBen(String value)

Setter for iaBen Custom filing information field for Iowa.

getCtReg

public String getCtReg()

Getter for ctReg Custom filing information field for Connecticut.

setCtReg

public void setCtReg(String value)

Setter for ctReg Custom filing information field for Connecticut.

getOther1Name

public String getOther1Name()

Getter for other1Name Custom filing information field. Leave blank.

setOther1Name

public void setOther1Name(String value)

Setter for other1Name Custom filing information field. Leave blank.

getOther1Value

public String getOther1Value()

Getter for other1Value Custom filing information field. Leave blank.

setOther1Value

public void setOther1Value(String value)

Setter for other1Value Custom filing information field. Leave blank.

getOther2Name

public String getOther2Name()

Getter for other2Name Custom filing information field. Leave blank.

setOther2Name

public void setOther2Name(String value)

Setter for other2Name Custom filing information field. Leave blank.

getOther2Value

public String getOther2Value()

Getter for other2Value Custom filing information field. Leave blank.

setOther2Value

public void setOther2Value(String value)

Setter for other2Value Custom filing information field. Leave blank.

getOther3Name

public String getOther3Name()

Getter for other3Name Custom filing information field. Leave blank.

setOther3Name

public void setOther3Name(String value)

Setter for other3Name Custom filing information field. Leave blank.

getOther3Value

public String getOther3Value()

Getter for other3Value Custom filing information field. Leave blank.

setOther3Value

public void setOther3Value(String value)

Setter for other3Value Custom filing information field. Leave blank.

getTaxAuthorityId

public Integer getTaxAuthorityId()

Getter for taxAuthorityId The unique ID of the tax authority of this return.

setTaxAuthorityId

public void setTaxAuthorityId(Integer value)

Setter for taxAuthorityId The unique ID of the tax authority of this return.

getTaxAuthorityName

public String getTaxAuthorityName()

Getter for taxAuthorityName The name of the tax authority of this return.

setTaxAuthorityName

public void setTaxAuthorityName(String value)

Setter for taxAuthorityName The name of the tax authority of this return.

getTaxAuthorityType

public String getTaxAuthorityType()

Getter for taxAuthorityType The type description of the tax authority of this return.

setTaxAuthorityType

public void setTaxAuthorityType(String value)

Setter for taxAuthorityType The type description of the tax authority of this return.

getCreatedDate

public Date getCreatedDate()

Getter for createdDate The date when this record was created.

setCreatedDate

public void setCreatedDate(Date value)

Setter for createdDate The date when this record was created.

getCreatedUserId

public Integer getCreatedUserId()

Getter for createdUserId The User ID of the user who created this record.

setCreatedUserId

public void setCreatedUserId(Integer value)

Setter for createdUserId The User ID of the user who created this record.

getModifiedDate

public Date getModifiedDate()

Getter for modifiedDate The date/time when this record was last modified.

setModifiedDate

public void setModifiedDate(Date value)

Setter for modifiedDate The date/time when this record was last modified.

getModifiedUserId

public Integer getModifiedUserId()

Getter for modifiedUserId The user ID of the user who last modified this record.

setModifiedUserId

public void setModifiedUserId(Integer value)

Setter for modifiedUserId The user ID of the user who last modified this record.

getBulkAccountId

public String getBulkAccountId()

Getter for bulkAccountId User name of bulk account.

setBulkAccountId

public void setBulkAccountId(String value)

Setter for bulkAccountId User name of bulk account.

getSiteCode

public String getSiteCode()

Getter for siteCode The bulk account site code.

setSiteCode

public void setSiteCode(String value)

Setter for siteCode The bulk account site code.

getBulkAccountValidationStatus

public BulkAccountValidationStatus getBulkAccountValidationStatus()

Getter for bulkAccountValidationStatus The status of the bulk account's validation.

setBulkAccountValidationStatus

public void setBulkAccountValidationStatus(BulkAccountValidationStatus value)

Setter for bulkAccountValidationStatus The status of the bulk account's validation.

getSettings

public ArrayList<CompanyReturnSettingModel> getSettings()

Getter for settings CompanyReturn settings for complext filing calendar

setSettings

public void setSettings(ArrayList<CompanyReturnSettingModel> value)

Setter for settings CompanyReturn settings for complext filing calendar

toString

public String toString()

Returns a JSON string representation of FilingCalendarModel

Overrides:

toString in class Object