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

Class FilingRequestDataModel

  • public class FilingRequestDataModel
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.util.ArrayList<FilingAnswerModel> getAnswers()
      Getter for answers Filing question answers
      java.lang.Long getCompanyReturnId()
      Getter for companyReturnId The company return ID if requesting an update.
      java.lang.String getCountry()
      Getter for country The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.
      java.util.Date getEffDate()
      Getter for effDate Filing cycle effective date of the request
      java.util.Date getEndDate()
      Getter for endDate Filing cycle end date of the request
      FilingFrequencyId getFilingFrequencyId()
      Getter for filingFrequencyId The filing frequency of the request
      java.lang.Integer getFiscalYearStartMonth()
      Getter for fiscalYearStartMonth The start period of a fiscal year for this form/company
      java.lang.Boolean getIsClone()
      Getter for isClone Flag if the request is a clone of a current filing calendar
      java.lang.String getLocationCode()
      Getter for locationCode Location code of the request
      java.lang.Short getMonths()
      Getter for months The months of the request
      java.lang.String getRegion()
      Getter for region The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.
      java.lang.String getRegistrationId()
      Getter for registrationId State registration ID of the company requesting the filing calendar.
      java.lang.String getReturnName()
      Getter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
      java.lang.Integer getTaxAuthorityId()
      Getter for taxAuthorityId The tax authority id of the return
      java.lang.String getTaxAuthorityName()
      Getter for taxAuthorityName The tax authority name on the 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 setAnswers​(java.util.ArrayList<FilingAnswerModel> value)
      Setter for answers Filing question answers
      void setCompanyReturnId​(java.lang.Long value)
      Setter for companyReturnId The company return ID if requesting an update.
      void setCountry​(java.lang.String value)
      Setter for country The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.
      void setEffDate​(java.util.Date value)
      Setter for effDate Filing cycle effective date of the request
      void setEndDate​(java.util.Date value)
      Setter for endDate Filing cycle end date of the request
      void setFilingFrequencyId​(FilingFrequencyId value)
      Setter for filingFrequencyId The filing frequency of the request
      void setFiscalYearStartMonth​(java.lang.Integer value)
      Setter for fiscalYearStartMonth The start period of a fiscal year for this form/company
      void setIsClone​(java.lang.Boolean value)
      Setter for isClone Flag if the request is a clone of a current filing calendar
      void setLocationCode​(java.lang.String value)
      Setter for locationCode Location code of the request
      void setMonths​(java.lang.Short value)
      Setter for months The months of the request
      void setRegion​(java.lang.String value)
      Setter for region The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.
      void setRegistrationId​(java.lang.String value)
      Setter for registrationId State registration ID of the company requesting the filing calendar.
      void setReturnName​(java.lang.String value)
      Setter for returnName DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
      void setTaxAuthorityId​(java.lang.Integer value)
      Setter for taxAuthorityId The tax authority id of the return
      void setTaxAuthorityName​(java.lang.String value)
      Setter for taxAuthorityName The tax authority name on the 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 FilingRequestDataModel

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FilingRequestDataModel

        public FilingRequestDataModel()

    • Method Detail

      • getCompanyReturnId

        public java.lang.Long getCompanyReturnId()
        Getter for companyReturnId The company return ID if requesting an update.

      • setCompanyReturnId

        public void setCompanyReturnId​(java.lang.Long value)
        Setter for companyReturnId The company return ID if requesting an update.

      • 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 requested calendar.

      • 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 requested calendar.

      • 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.

      • getFilingFrequencyId

        public FilingFrequencyId getFilingFrequencyId()
        Getter for filingFrequencyId The filing frequency of the request

      • setFilingFrequencyId

        public void setFilingFrequencyId​(FilingFrequencyId value)
        Setter for filingFrequencyId The filing frequency of the request

      • getRegistrationId

        public java.lang.String getRegistrationId()
        Getter for registrationId State registration ID of the company requesting the filing calendar.

      • setRegistrationId

        public void setRegistrationId​(java.lang.String value)
        Setter for registrationId State registration ID of the company requesting the filing calendar.

      • getMonths

        public java.lang.Short getMonths()
        Getter for months The months of the request

      • setMonths

        public void setMonths​(java.lang.Short value)
        Setter for months The months of the request

      • 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

      • 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.

      • getLocationCode

        public java.lang.String getLocationCode()
        Getter for locationCode Location code of the request

      • setLocationCode

        public void setLocationCode​(java.lang.String value)
        Setter for locationCode Location code of the request

      • getEffDate

        public java.util.Date getEffDate()
        Getter for effDate Filing cycle effective date of the request

      • setEffDate

        public void setEffDate​(java.util.Date value)
        Setter for effDate Filing cycle effective date of the request

      • getEndDate

        public java.util.Date getEndDate()
        Getter for endDate Filing cycle end date of the request

      • setEndDate

        public void setEndDate​(java.util.Date value)
        Setter for endDate Filing cycle end date of the request

      • getIsClone

        public java.lang.Boolean getIsClone()
        Getter for isClone Flag if the request is a clone of a current filing calendar

      • setIsClone

        public void setIsClone​(java.lang.Boolean value)
        Setter for isClone Flag if the request is a clone of a current filing calendar

      • getCountry

        public java.lang.String getCountry()
        Getter for country The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.

      • setCountry

        public void setCountry​(java.lang.String value)
        Setter for country The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.

      • getRegion

        public java.lang.String getRegion()
        Getter for region The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.

      • setRegion

        public void setRegion​(java.lang.String value)
        Setter for region The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.

      • getTaxAuthorityId

        public java.lang.Integer getTaxAuthorityId()
        Getter for taxAuthorityId The tax authority id of the return

      • setTaxAuthorityId

        public void setTaxAuthorityId​(java.lang.Integer value)
        Setter for taxAuthorityId The tax authority id of the return

      • getTaxAuthorityName

        public java.lang.String getTaxAuthorityName()
        Getter for taxAuthorityName The tax authority name on the return

      • setTaxAuthorityName

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

      • getAnswers

        public java.util.ArrayList<FilingAnswerModel> getAnswers()
        Getter for answers Filing question answers

      • setAnswers

        public void setAnswers​(java.util.ArrayList<FilingAnswerModel> value)
        Setter for answers Filing question answers

      • toString

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