Class FilingCalendarModel


  • public class FilingCalendarModel
    extends java.lang.Object
    Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAlAccessCode()
      Getter for alAccessCode Custom filing information field for Alabama.
      java.lang.String getAlSignOn()
      Getter for alSignOn Custom filing information field for Alabama.
      java.lang.String getBulkAccountId()
      Getter for bulkAccountId User name of bulk account.
      BulkAccountValidationStatus getBulkAccountValidationStatus()
      Getter for bulkAccountValidationStatus The status of the bulk account's validation.
      java.lang.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.
      java.lang.Integer getCompanyId()
      Getter for companyId The unique ID number of the company to which this filing calendar belongs.
      java.lang.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.
      java.util.Date getCreatedDate()
      Getter for createdDate The date when this record was created.
      java.lang.Integer getCreatedUserId()
      Getter for createdUserId The User ID of the user who created this record.
      java.lang.String getCtReg()
      Getter for ctReg Custom filing information field for Connecticut.
      java.lang.String getCustomerFilingInstructions()
      Getter for customerFilingInstructions Special filing instructions to be used when filing this return.
      java.util.Date getEffectiveDate()
      Getter for effectiveDate The earliest date for the tax period when this return should be filed.
      java.lang.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.
      java.lang.String getEFileUsername()
      Getter for eFileUsername If you file electronically, this is the username you use to log in to the tax authority's website.
      java.lang.String getEmployerIdentificationNumber()
      Getter for employerIdentificationNumber The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
      java.util.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.
      java.lang.Integer getFiscalYearStartMonth()
      Getter for fiscalYearStartMonth The start period of a fiscal year for this form/company
      java.math.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.
      java.lang.String getFormCountry()
      Getter for formCountry Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar.
      java.lang.String getFormRegion()
      Getter for formRegion Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar.
      java.lang.String getIaBen()
      Getter for iaBen Custom filing information field for Iowa.
      java.lang.Long getId()
      Getter for id The unique ID number of this filing calendar.
      java.lang.String getInternalNotes()
      Getter for internalNotes Internal filing notes.
      java.lang.String getLegalEntityName()
      Getter for legalEntityName The legal entity name to be used when filing this return.
      java.lang.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.
      java.lang.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.
      java.lang.String getLocalRegistrationId()
      Getter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.
      java.lang.String getLocationCode()
      Getter for locationCode If this calendar is for a location-specific tax return, specify the location code here.
      java.lang.String getMailingAddressCity()
      Getter for mailingAddressCity The city name of the mailing address that will be used when filling out this tax return.
      java.lang.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.
      java.lang.String getMailingAddressLine1()
      Getter for mailingAddressLine1 The first line of the mailing address that will be used when filling out this tax return.
      java.lang.String getMailingAddressLine2()
      Getter for mailingAddressLine2 The second line of the mailing address that will be used when filling out this tax return.
      java.lang.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.
      java.lang.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.
      java.lang.String getMeBusinessCode()
      Getter for meBusinessCode Custom filing information field for Maine.
      java.util.Date getModifiedDate()
      Getter for modifiedDate The date/time when this record was last modified.
      java.lang.Integer getModifiedUserId()
      Getter for modifiedUserId The user ID of the user who last modified this record.
      java.lang.Short getMonths()
      Getter for months A 16-bit bitmap containing a 1 for each month when the return should be filed.
      java.lang.String getOther1Name()
      Getter for other1Name Custom filing information field.
      java.lang.String getOther1Value()
      Getter for other1Value Custom filing information field.
      java.lang.String getOther2Name()
      Getter for other2Name Custom filing information field.
      java.lang.String getOther2Value()
      Getter for other2Value Custom filing information field.
      java.lang.String getOther3Name()
      Getter for other3Name Custom filing information field.
      java.lang.String getOther3Value()
      Getter for other3Value Custom filing information field.
      OutletTypeId getOutletTypeId()
      Getter for outletTypeId If this calendar is for a location-specific tax return, specify the location-specific behavior here.
      java.lang.String getPaymentCurrency()
      Getter for paymentCurrency Specify the ISO 4217 currency code for the currency to remit for this tax return.
      java.lang.String getPhone()
      Getter for phone The phone number to be used when filing this return.
      java.lang.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.
      java.lang.Boolean getPrePaymentRequired()
      Getter for prePaymentRequired Determines if a prepayment is required for this filing calendar
      java.lang.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%.
      java.lang.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.
      java.lang.String getReturnName()
      Getter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
      java.util.ArrayList<CompanyReturnSettingModel> getSettings()
      Getter for settings CompanyReturn settings for complext filing calendar
      java.lang.String getSiteCode()
      Getter for siteCode The bulk account site code.
      java.lang.String getStateRegistrationId()
      Getter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.
      java.lang.Integer getTaxAuthorityId()
      Getter for taxAuthorityId The unique ID of the tax authority of this return.
      java.lang.String getTaxAuthorityName()
      Getter for taxAuthorityName The name of the tax authority of this return.
      java.lang.String getTaxAuthorityType()
      Getter for taxAuthorityType The type description of the tax authority of this return.
      java.lang.String getTaxFormCode()
      Getter for taxFormCode The Avalara standard tax form code of the tax form for this filing calendar.
      MatchingTaxType getTaxTypeId()
      Getter for taxTypeId The type of tax to report on this return.
      void setAlAccessCode​(java.lang.String value)
      Setter for alAccessCode Custom filing information field for Alabama.
      void setAlSignOn​(java.lang.String value)
      Setter for alSignOn Custom filing information field for Alabama.
      void setBulkAccountId​(java.lang.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​(java.lang.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​(java.lang.Integer value)
      Setter for companyId The unique ID number of the company to which this filing calendar belongs.
      void setCountry​(java.lang.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​(java.util.Date value)
      Setter for createdDate The date when this record was created.
      void setCreatedUserId​(java.lang.Integer value)
      Setter for createdUserId The User ID of the user who created this record.
      void setCtReg​(java.lang.String value)
      Setter for ctReg Custom filing information field for Connecticut.
      void setCustomerFilingInstructions​(java.lang.String value)
      Setter for customerFilingInstructions Special filing instructions to be used when filing this return.
      void setEffectiveDate​(java.util.Date value)
      Setter for effectiveDate The earliest date for the tax period when this return should be filed.
      void setEFilePassword​(java.lang.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​(java.lang.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​(java.lang.String value)
      Setter for employerIdentificationNumber The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
      void setEndDate​(java.util.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​(java.lang.Integer value)
      Setter for fiscalYearStartMonth The start period of a fiscal year for this form/company
      void setFixedPrepaymentAmount​(java.math.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​(java.lang.String value)
      Setter for formCountry Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar.
      void setFormRegion​(java.lang.String value)
      Setter for formRegion Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar.
      void setIaBen​(java.lang.String value)
      Setter for iaBen Custom filing information field for Iowa.
      void setId​(java.lang.Long value)
      Setter for id The unique ID number of this filing calendar.
      void setInternalNotes​(java.lang.String value)
      Setter for internalNotes Internal filing notes.
      void setLegalEntityName​(java.lang.String value)
      Setter for legalEntityName The legal entity name to be used when filing this return.
      void setLine1​(java.lang.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​(java.lang.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​(java.lang.String value)
      Setter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.
      void setLocationCode​(java.lang.String value)
      Setter for locationCode If this calendar is for a location-specific tax return, specify the location code here.
      void setMailingAddressCity​(java.lang.String value)
      Setter for mailingAddressCity The city name of the mailing address that will be used when filling out this tax return.
      void setMailingAddressCountry​(java.lang.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​(java.lang.String value)
      Setter for mailingAddressLine1 The first line of the mailing address that will be used when filling out this tax return.
      void setMailingAddressLine2​(java.lang.String value)
      Setter for mailingAddressLine2 The second line of the mailing address that will be used when filling out this tax return.
      void setMailingAddressPostalCode​(java.lang.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​(java.lang.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​(java.lang.String value)
      Setter for meBusinessCode Custom filing information field for Maine.
      void setModifiedDate​(java.util.Date value)
      Setter for modifiedDate The date/time when this record was last modified.
      void setModifiedUserId​(java.lang.Integer value)
      Setter for modifiedUserId The user ID of the user who last modified this record.
      void setMonths​(java.lang.Short value)
      Setter for months A 16-bit bitmap containing a 1 for each month when the return should be filed.
      void setOther1Name​(java.lang.String value)
      Setter for other1Name Custom filing information field.
      void setOther1Value​(java.lang.String value)
      Setter for other1Value Custom filing information field.
      void setOther2Name​(java.lang.String value)
      Setter for other2Name Custom filing information field.
      void setOther2Value​(java.lang.String value)
      Setter for other2Value Custom filing information field.
      void setOther3Name​(java.lang.String value)
      Setter for other3Name Custom filing information field.
      void setOther3Value​(java.lang.String value)
      Setter for other3Value Custom filing information field.
      void setOutletTypeId​(OutletTypeId value)
      Setter for outletTypeId If this calendar is for a location-specific tax return, specify the location-specific behavior here.
      void setPaymentCurrency​(java.lang.String value)
      Setter for paymentCurrency Specify the ISO 4217 currency code for the currency to remit for this tax return.
      void setPhone​(java.lang.String value)
      Setter for phone The phone number to be used when filing this return.
      void setPostalCode​(java.lang.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​(java.lang.Boolean value)
      Setter for prePaymentRequired Determines if a prepayment is required for this filing calendar
      void setPrepayPercentage​(java.lang.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​(java.lang.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​(java.lang.String value)
      Setter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
      void setSettings​(java.util.ArrayList<CompanyReturnSettingModel> value)
      Setter for settings CompanyReturn settings for complext filing calendar
      void setSiteCode​(java.lang.String value)
      Setter for siteCode The bulk account site code.
      void setStateRegistrationId​(java.lang.String value)
      Setter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.
      void setTaxAuthorityId​(java.lang.Integer value)
      Setter for taxAuthorityId The unique ID of the tax authority of this return.
      void setTaxAuthorityName​(java.lang.String value)
      Setter for taxAuthorityName The name of the tax authority of this return.
      void setTaxAuthorityType​(java.lang.String value)
      Setter for taxAuthorityType The type description of the tax authority of this return.
      void setTaxFormCode​(java.lang.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 The type of tax to report on this return.
      java.lang.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 Detail

      • FilingCalendarModel

        public FilingCalendarModel()
    • Method Detail

      • getId

        public java.lang.Long getId()
        Getter for id The unique ID number of this filing calendar.
      • setId

        public void setId​(java.lang.Long value)
        Setter for id The unique ID number of this filing calendar.
      • getCompanyId

        public java.lang.Integer getCompanyId()
        Getter for companyId The unique ID number of the company to which this filing calendar belongs.
      • setCompanyId

        public void setCompanyId​(java.lang.Integer value)
        Setter for companyId The unique ID number of the company to which this filing calendar belongs.
      • getReturnName

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Integer getFiscalYearStartMonth()
        Getter for fiscalYearStartMonth The start period of a fiscal year for this form/company
      • setFiscalYearStartMonth

        public void setFiscalYearStartMonth​(java.lang.Integer value)
        Setter for fiscalYearStartMonth The start period of a fiscal year for this form/company
      • getLocationCode

        public java.lang.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​(java.lang.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 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 If this calendar is for a location-specific tax return, specify the location-specific behavior here.
      • getPaymentCurrency

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.Short value)
        Setter for months A 16-bit bitmap containing a 1 for each month when the return should be filed.
      • getStateRegistrationId

        public java.lang.String getStateRegistrationId()
        Getter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.
      • setStateRegistrationId

        public void setStateRegistrationId​(java.lang.String value)
        Setter for stateRegistrationId Tax Registration ID for this Region - in the U.S., this is for your state.
      • getLocalRegistrationId

        public java.lang.String getLocalRegistrationId()
        Getter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.
      • setLocalRegistrationId

        public void setLocalRegistrationId​(java.lang.String value)
        Setter for localRegistrationId Tax Registration ID for the local jurisdiction, if any.
      • getEmployerIdentificationNumber

        public java.lang.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​(java.lang.String value)
        Setter for employerIdentificationNumber The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
      • getLine1

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.String value)
        Setter for mailingAddressLine1 The first line of the mailing address that will be used when filling out this tax return.
      • getMailingAddressLine2

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.String value)
        Setter for mailingAddressCity The city name of the mailing address that will be used when filling out this tax return.
      • getMailingAddressRegion

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.String getPhone()
        Getter for phone The phone number to be used when filing this return.
      • setPhone

        public void setPhone​(java.lang.String value)
        Setter for phone The phone number to be used when filing this return.
      • getCustomerFilingInstructions

        public java.lang.String getCustomerFilingInstructions()
        Getter for customerFilingInstructions 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​(java.lang.String value)
        Setter for customerFilingInstructions Special filing instructions to be used when filing this return. Please note that requesting special filing instructions may incur additional costs.
      • getLegalEntityName

        public java.lang.String getLegalEntityName()
        Getter for legalEntityName The legal entity name to be used when filing this return.
      • setLegalEntityName

        public void setLegalEntityName​(java.lang.String value)
        Setter for legalEntityName The legal entity name to be used when filing this return.
      • getEffectiveDate

        public java.util.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​(java.util.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 java.util.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​(java.util.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Boolean getPrePaymentRequired()
        Getter for prePaymentRequired Determines if a prepayment is required for this filing calendar
      • setPrePaymentRequired

        public void setPrePaymentRequired​(java.lang.Boolean value)
        Setter for prePaymentRequired Determines if a prepayment is required for this filing calendar
      • getFixedPrepaymentAmount

        public java.math.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​(java.math.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 The type of tax to report on this return.
      • setTaxTypeId

        public void setTaxTypeId​(MatchingTaxType value)
        Setter for taxTypeId The type of tax to report on this return.
      • getInternalNotes

        public java.lang.String getInternalNotes()
        Getter for internalNotes Internal filing notes.
      • setInternalNotes

        public void setInternalNotes​(java.lang.String value)
        Setter for internalNotes Internal filing notes.
      • getAlSignOn

        public java.lang.String getAlSignOn()
        Getter for alSignOn Custom filing information field for Alabama.
      • setAlSignOn

        public void setAlSignOn​(java.lang.String value)
        Setter for alSignOn Custom filing information field for Alabama.
      • getAlAccessCode

        public java.lang.String getAlAccessCode()
        Getter for alAccessCode Custom filing information field for Alabama.
      • setAlAccessCode

        public void setAlAccessCode​(java.lang.String value)
        Setter for alAccessCode Custom filing information field for Alabama.
      • getMeBusinessCode

        public java.lang.String getMeBusinessCode()
        Getter for meBusinessCode Custom filing information field for Maine.
      • setMeBusinessCode

        public void setMeBusinessCode​(java.lang.String value)
        Setter for meBusinessCode Custom filing information field for Maine.
      • getIaBen

        public java.lang.String getIaBen()
        Getter for iaBen Custom filing information field for Iowa.
      • setIaBen

        public void setIaBen​(java.lang.String value)
        Setter for iaBen Custom filing information field for Iowa.
      • getCtReg

        public java.lang.String getCtReg()
        Getter for ctReg Custom filing information field for Connecticut.
      • setCtReg

        public void setCtReg​(java.lang.String value)
        Setter for ctReg Custom filing information field for Connecticut.
      • getOther1Name

        public java.lang.String getOther1Name()
        Getter for other1Name Custom filing information field. Leave blank.
      • setOther1Name

        public void setOther1Name​(java.lang.String value)
        Setter for other1Name Custom filing information field. Leave blank.
      • getOther1Value

        public java.lang.String getOther1Value()
        Getter for other1Value Custom filing information field. Leave blank.
      • setOther1Value

        public void setOther1Value​(java.lang.String value)
        Setter for other1Value Custom filing information field. Leave blank.
      • getOther2Name

        public java.lang.String getOther2Name()
        Getter for other2Name Custom filing information field. Leave blank.
      • setOther2Name

        public void setOther2Name​(java.lang.String value)
        Setter for other2Name Custom filing information field. Leave blank.
      • getOther2Value

        public java.lang.String getOther2Value()
        Getter for other2Value Custom filing information field. Leave blank.
      • setOther2Value

        public void setOther2Value​(java.lang.String value)
        Setter for other2Value Custom filing information field. Leave blank.
      • getOther3Name

        public java.lang.String getOther3Name()
        Getter for other3Name Custom filing information field. Leave blank.
      • setOther3Name

        public void setOther3Name​(java.lang.String value)
        Setter for other3Name Custom filing information field. Leave blank.
      • getOther3Value

        public java.lang.String getOther3Value()
        Getter for other3Value Custom filing information field. Leave blank.
      • setOther3Value

        public void setOther3Value​(java.lang.String value)
        Setter for other3Value Custom filing information field. Leave blank.
      • getTaxAuthorityId

        public java.lang.Integer getTaxAuthorityId()
        Getter for taxAuthorityId The unique ID of the tax authority of this return.
      • setTaxAuthorityId

        public void setTaxAuthorityId​(java.lang.Integer value)
        Setter for taxAuthorityId The unique ID of the tax authority of this return.
      • getTaxAuthorityName

        public java.lang.String getTaxAuthorityName()
        Getter for taxAuthorityName The name of the tax authority of this return.
      • setTaxAuthorityName

        public void setTaxAuthorityName​(java.lang.String value)
        Setter for taxAuthorityName The name of the tax authority of this return.
      • getTaxAuthorityType

        public java.lang.String getTaxAuthorityType()
        Getter for taxAuthorityType The type description of the tax authority of this return.
      • setTaxAuthorityType

        public void setTaxAuthorityType​(java.lang.String value)
        Setter for taxAuthorityType The type description of the tax authority of this return.
      • getCreatedDate

        public java.util.Date getCreatedDate()
        Getter for createdDate The date when this record was created.
      • setCreatedDate

        public void setCreatedDate​(java.util.Date value)
        Setter for createdDate The date when this record was created.
      • getCreatedUserId

        public java.lang.Integer getCreatedUserId()
        Getter for createdUserId The User ID of the user who created this record.
      • setCreatedUserId

        public void setCreatedUserId​(java.lang.Integer value)
        Setter for createdUserId The User ID of the user who created this record.
      • getModifiedDate

        public java.util.Date getModifiedDate()
        Getter for modifiedDate The date/time when this record was last modified.
      • setModifiedDate

        public void setModifiedDate​(java.util.Date value)
        Setter for modifiedDate The date/time when this record was last modified.
      • getModifiedUserId

        public java.lang.Integer getModifiedUserId()
        Getter for modifiedUserId The user ID of the user who last modified this record.
      • setModifiedUserId

        public void setModifiedUserId​(java.lang.Integer value)
        Setter for modifiedUserId The user ID of the user who last modified this record.
      • getBulkAccountId

        public java.lang.String getBulkAccountId()
        Getter for bulkAccountId User name of bulk account.
      • setBulkAccountId

        public void setBulkAccountId​(java.lang.String value)
        Setter for bulkAccountId User name of bulk account.
      • getSiteCode

        public java.lang.String getSiteCode()
        Getter for siteCode The bulk account site code.
      • setSiteCode

        public void setSiteCode​(java.lang.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 java.util.ArrayList<CompanyReturnSettingModel> getSettings()
        Getter for settings CompanyReturn settings for complext filing calendar
      • setSettings

        public void setSettings​(java.util.ArrayList<CompanyReturnSettingModel> value)
        Setter for settings CompanyReturn settings for complext filing calendar
      • toString

        public java.lang.String toString()
        Returns a JSON string representation of FilingCalendarModel
        Overrides:
        toString in class java.lang.Object