Class NoticeModel


  • public class NoticeModel
    extends java.lang.Object
    Represents a letter received from a tax authority regarding tax filing. These letters often have the warning "Notice" printed at the top, which is why they are called "Notices".
    • Constructor Summary

      Constructors 
      Constructor Description
      NoticeModel()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getAvaFileFormId()
      Getter for avaFileFormId The ava file form id of the notice
      java.lang.Integer getClosedByUserId()
      Getter for closedByUserId The unique ID number of the user that closed the notice
      java.util.Date getClosedDate()
      Getter for closedDate The closed date of the notice
      java.util.ArrayList<NoticeCommentModel> getComments()
      Getter for comments Additional comments on the notice
      java.lang.Integer getCompanyId()
      Getter for companyId The unique ID number of the company to which this notice belongs.
      java.lang.Integer getComplianceContactId()
      Getter for complianceContactId The id of the compliance contact
      java.lang.String getCountry()
      Getter for country Name or ISO 3166 code identifying the country that sent this notice.
      java.lang.String getCreatedByUserName()
      Getter for createdByUserName The user who created the notice
      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 getCustomerComment()
      Getter for customerComment Comments from the customer on this notice
      FundingOption getCustomerFundingOptionId()
      Getter for customerFundingOptionId The notice customer funding options
      NoticeCustomerType getCustomerTypeId()
      Getter for customerTypeId NoticeCustomerTypeID can be retrieved from the definitions API
      java.lang.String getDescription()
      Getter for description The description of the notice
      java.lang.String getDocumentReference()
      Getter for documentReference The document reference of the notice
      java.util.Date getExpectedResolutionDate()
      Getter for expectedResolutionDate Expected resolution date of the notice
      FilingFrequencyId getFilingFrequency()
      Getter for filingFrequency The filing frequency of the notice
      TaxNoticeFilingTypeId getFilingTypeId()
      Getter for filingTypeId The filing type of the notice
      java.util.ArrayList<NoticeFinanceModel> getFinances()
      Getter for finances Finance details of the notice
      java.lang.Boolean getHideFromCustomer()
      Getter for hideFromCustomer Indicator to hide from customer
      java.lang.Integer getId()
      Getter for id The unique ID number of this notice.
      java.lang.String getJurisdictionName()
      Getter for jurisdictionName The jurisdiction name of the notice
      java.lang.String getJurisdictionType()
      Getter for jurisdictionType The jurisdiction type of the notice
      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.Integer getOwnedByUserId()
      Getter for ownedByUserId The unique ID number of the user that owns the notice
      NoticePriorityId getPriorityId()
      Getter for priorityId The priority of the notice
      java.lang.String getReason()
      Getter for reason The notice reason
      java.lang.Integer getReasonId()
      Getter for reasonId The notice reason id
      java.util.Date getReceivedDate()
      Getter for receivedDate The received date of the notice
      java.lang.String getRegion()
      Getter for region Name or ISO 3166 code identifying the region within the country that sent this notice.
      java.util.ArrayList<NoticeResponsibilityDetailModel> getResponsibility()
      Getter for responsibility Notice Responsibility Details
      java.lang.Integer getRevenueContactId()
      Getter for revenueContactId The id of the revenue contact
      java.util.ArrayList<NoticeRootCauseDetailModel> getRootCause()
      Getter for rootCause Notice Root Cause Details
      java.lang.String getSalesForceCase()
      Getter for salesForceCase The sales force case of the notice
      java.lang.String getSalesForceCaseUrl()
      Getter for salesForceCaseUrl The URL to the sales force case
      java.lang.Boolean getShowResolutionDateToCustomer()
      Getter for showResolutionDateToCustomer Indicator to show customer this resolution date
      java.lang.String getStatus()
      Getter for status The status of the notice
      java.lang.Integer getStatusId()
      Getter for statusId The status id of the notice
      java.lang.Integer getTaxAuthorityId()
      Getter for taxAuthorityId The tax authority id of the notice
      java.lang.String getTaxFormCode()
      Getter for taxFormCode The tax form code of the notice
      java.lang.String getTaxPeriod()
      Getter for taxPeriod The tax period of the notice
      java.lang.String getTicketReferenceNo()
      Getter for ticketReferenceNo The ticket reference number of the notice
      java.lang.String getTicketReferenceUrl()
      Getter for ticketReferenceUrl The ticket reference url of the notice
      java.math.BigDecimal getTotalRemit()
      Getter for totalRemit The total remmitance amount for the notice
      java.lang.String getType()
      Getter for type The tax notice type description
      java.lang.Integer getTypeId()
      Getter for typeId The tax notice type id
      void setAvaFileFormId​(java.lang.Integer value)
      Setter for avaFileFormId The ava file form id of the notice
      void setClosedByUserId​(java.lang.Integer value)
      Setter for closedByUserId The unique ID number of the user that closed the notice
      void setClosedDate​(java.util.Date value)
      Setter for closedDate The closed date of the notice
      void setComments​(java.util.ArrayList<NoticeCommentModel> value)
      Setter for comments Additional comments on the notice
      void setCompanyId​(java.lang.Integer value)
      Setter for companyId The unique ID number of the company to which this notice belongs.
      void setComplianceContactId​(java.lang.Integer value)
      Setter for complianceContactId The id of the compliance contact
      void setCountry​(java.lang.String value)
      Setter for country Name or ISO 3166 code identifying the country that sent this notice.
      void setCreatedByUserName​(java.lang.String value)
      Setter for createdByUserName The user who created the notice
      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 setCustomerComment​(java.lang.String value)
      Setter for customerComment Comments from the customer on this notice
      void setCustomerFundingOptionId​(FundingOption value)
      Setter for customerFundingOptionId The notice customer funding options
      void setCustomerTypeId​(NoticeCustomerType value)
      Setter for customerTypeId NoticeCustomerTypeID can be retrieved from the definitions API
      void setDescription​(java.lang.String value)
      Setter for description The description of the notice
      void setDocumentReference​(java.lang.String value)
      Setter for documentReference The document reference of the notice
      void setExpectedResolutionDate​(java.util.Date value)
      Setter for expectedResolutionDate Expected resolution date of the notice
      void setFilingFrequency​(FilingFrequencyId value)
      Setter for filingFrequency The filing frequency of the notice
      void setFilingTypeId​(TaxNoticeFilingTypeId value)
      Setter for filingTypeId The filing type of the notice
      void setFinances​(java.util.ArrayList<NoticeFinanceModel> value)
      Setter for finances Finance details of the notice
      void setHideFromCustomer​(java.lang.Boolean value)
      Setter for hideFromCustomer Indicator to hide from customer
      void setId​(java.lang.Integer value)
      Setter for id The unique ID number of this notice.
      void setJurisdictionName​(java.lang.String value)
      Setter for jurisdictionName The jurisdiction name of the notice
      void setJurisdictionType​(java.lang.String value)
      Setter for jurisdictionType The jurisdiction type of the notice
      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 setOwnedByUserId​(java.lang.Integer value)
      Setter for ownedByUserId The unique ID number of the user that owns the notice
      void setPriorityId​(NoticePriorityId value)
      Setter for priorityId The priority of the notice
      void setReason​(java.lang.String value)
      Setter for reason The notice reason
      void setReasonId​(java.lang.Integer value)
      Setter for reasonId The notice reason id
      void setReceivedDate​(java.util.Date value)
      Setter for receivedDate The received date of the notice
      void setRegion​(java.lang.String value)
      Setter for region Name or ISO 3166 code identifying the region within the country that sent this notice.
      void setResponsibility​(java.util.ArrayList<NoticeResponsibilityDetailModel> value)
      Setter for responsibility Notice Responsibility Details
      void setRevenueContactId​(java.lang.Integer value)
      Setter for revenueContactId The id of the revenue contact
      void setRootCause​(java.util.ArrayList<NoticeRootCauseDetailModel> value)
      Setter for rootCause Notice Root Cause Details
      void setSalesForceCase​(java.lang.String value)
      Setter for salesForceCase The sales force case of the notice
      void setSalesForceCaseUrl​(java.lang.String value)
      Setter for salesForceCaseUrl The URL to the sales force case
      void setShowResolutionDateToCustomer​(java.lang.Boolean value)
      Setter for showResolutionDateToCustomer Indicator to show customer this resolution date
      void setStatus​(java.lang.String value)
      Setter for status The status of the notice
      void setStatusId​(java.lang.Integer value)
      Setter for statusId The status id of the notice
      void setTaxAuthorityId​(java.lang.Integer value)
      Setter for taxAuthorityId The tax authority id of the notice
      void setTaxFormCode​(java.lang.String value)
      Setter for taxFormCode The tax form code of the notice
      void setTaxPeriod​(java.lang.String value)
      Setter for taxPeriod The tax period of the notice
      void setTicketReferenceNo​(java.lang.String value)
      Setter for ticketReferenceNo The ticket reference number of the notice
      void setTicketReferenceUrl​(java.lang.String value)
      Setter for ticketReferenceUrl The ticket reference url of the notice
      void setTotalRemit​(java.math.BigDecimal value)
      Setter for totalRemit The total remmitance amount for the notice
      void setType​(java.lang.String value)
      Setter for type The tax notice type description
      void setTypeId​(java.lang.Integer value)
      Setter for typeId The tax notice type id
      java.lang.String toString()
      Returns a JSON string representation of NoticeModel
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • NoticeModel

        public NoticeModel()
    • Method Detail

      • getId

        public java.lang.Integer getId()
        Getter for id The unique ID number of this notice.
      • setId

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

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

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

        public java.lang.Integer getStatusId()
        Getter for statusId The status id of the notice
      • setStatusId

        public void setStatusId​(java.lang.Integer value)
        Setter for statusId The status id of the notice
      • getStatus

        public java.lang.String getStatus()
        Getter for status The status of the notice
      • setStatus

        public void setStatus​(java.lang.String value)
        Setter for status The status of the notice
      • getReceivedDate

        public java.util.Date getReceivedDate()
        Getter for receivedDate The received date of the notice
      • setReceivedDate

        public void setReceivedDate​(java.util.Date value)
        Setter for receivedDate The received date of the notice
      • getClosedDate

        public java.util.Date getClosedDate()
        Getter for closedDate The closed date of the notice
      • setClosedDate

        public void setClosedDate​(java.util.Date value)
        Setter for closedDate The closed date of the notice
      • getTotalRemit

        public java.math.BigDecimal getTotalRemit()
        Getter for totalRemit The total remmitance amount for the notice
      • setTotalRemit

        public void setTotalRemit​(java.math.BigDecimal value)
        Setter for totalRemit The total remmitance amount for the notice
      • getCustomerTypeId

        public NoticeCustomerType getCustomerTypeId()
        Getter for customerTypeId NoticeCustomerTypeID can be retrieved from the definitions API
      • setCustomerTypeId

        public void setCustomerTypeId​(NoticeCustomerType value)
        Setter for customerTypeId NoticeCustomerTypeID can be retrieved from the definitions API
      • getCountry

        public java.lang.String getCountry()
        Getter for country Name or ISO 3166 code identifying the country that sent this notice. 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`.
      • setCountry

        public void setCountry​(java.lang.String value)
        Setter for country Name or ISO 3166 code identifying the country that sent this notice. 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`.
      • getRegion

        public java.lang.String getRegion()
        Getter for region Name or ISO 3166 code identifying the region within the country that sent this notice. 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`.
      • setRegion

        public void setRegion​(java.lang.String value)
        Setter for region Name or ISO 3166 code identifying the region within the country that sent this notice. 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`.
      • getTaxAuthorityId

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

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

        public FilingFrequencyId getFilingFrequency()
        Getter for filingFrequency The filing frequency of the notice
      • setFilingFrequency

        public void setFilingFrequency​(FilingFrequencyId value)
        Setter for filingFrequency The filing frequency of the notice
      • getFilingTypeId

        public TaxNoticeFilingTypeId getFilingTypeId()
        Getter for filingTypeId The filing type of the notice
      • setFilingTypeId

        public void setFilingTypeId​(TaxNoticeFilingTypeId value)
        Setter for filingTypeId The filing type of the notice
      • getTicketReferenceNo

        public java.lang.String getTicketReferenceNo()
        Getter for ticketReferenceNo The ticket reference number of the notice
      • setTicketReferenceNo

        public void setTicketReferenceNo​(java.lang.String value)
        Setter for ticketReferenceNo The ticket reference number of the notice
      • getTicketReferenceUrl

        public java.lang.String getTicketReferenceUrl()
        Getter for ticketReferenceUrl The ticket reference url of the notice
      • setTicketReferenceUrl

        public void setTicketReferenceUrl​(java.lang.String value)
        Setter for ticketReferenceUrl The ticket reference url of the notice
      • getSalesForceCase

        public java.lang.String getSalesForceCase()
        Getter for salesForceCase The sales force case of the notice
      • setSalesForceCase

        public void setSalesForceCase​(java.lang.String value)
        Setter for salesForceCase The sales force case of the notice
      • getSalesForceCaseUrl

        public java.lang.String getSalesForceCaseUrl()
        Getter for salesForceCaseUrl The URL to the sales force case
      • setSalesForceCaseUrl

        public void setSalesForceCaseUrl​(java.lang.String value)
        Setter for salesForceCaseUrl The URL to the sales force case
      • getTaxPeriod

        public java.lang.String getTaxPeriod()
        Getter for taxPeriod The tax period of the notice
      • setTaxPeriod

        public void setTaxPeriod​(java.lang.String value)
        Setter for taxPeriod The tax period of the notice
      • getReasonId

        public java.lang.Integer getReasonId()
        Getter for reasonId The notice reason id
      • setReasonId

        public void setReasonId​(java.lang.Integer value)
        Setter for reasonId The notice reason id
      • getReason

        public java.lang.String getReason()
        Getter for reason The notice reason
      • setReason

        public void setReason​(java.lang.String value)
        Setter for reason The notice reason
      • getTypeId

        public java.lang.Integer getTypeId()
        Getter for typeId The tax notice type id
      • setTypeId

        public void setTypeId​(java.lang.Integer value)
        Setter for typeId The tax notice type id
      • getType

        public java.lang.String getType()
        Getter for type The tax notice type description
      • setType

        public void setType​(java.lang.String value)
        Setter for type The tax notice type description
      • getCustomerFundingOptionId

        public FundingOption getCustomerFundingOptionId()
        Getter for customerFundingOptionId The notice customer funding options
      • setCustomerFundingOptionId

        public void setCustomerFundingOptionId​(FundingOption value)
        Setter for customerFundingOptionId The notice customer funding options
      • getPriorityId

        public NoticePriorityId getPriorityId()
        Getter for priorityId The priority of the notice
      • setPriorityId

        public void setPriorityId​(NoticePriorityId value)
        Setter for priorityId The priority of the notice
      • getCustomerComment

        public java.lang.String getCustomerComment()
        Getter for customerComment Comments from the customer on this notice
      • setCustomerComment

        public void setCustomerComment​(java.lang.String value)
        Setter for customerComment Comments from the customer on this notice
      • getHideFromCustomer

        public java.lang.Boolean getHideFromCustomer()
        Getter for hideFromCustomer Indicator to hide from customer
      • setHideFromCustomer

        public void setHideFromCustomer​(java.lang.Boolean value)
        Setter for hideFromCustomer Indicator to hide from customer
      • getExpectedResolutionDate

        public java.util.Date getExpectedResolutionDate()
        Getter for expectedResolutionDate Expected resolution date of the notice
      • setExpectedResolutionDate

        public void setExpectedResolutionDate​(java.util.Date value)
        Setter for expectedResolutionDate Expected resolution date of the notice
      • getShowResolutionDateToCustomer

        public java.lang.Boolean getShowResolutionDateToCustomer()
        Getter for showResolutionDateToCustomer Indicator to show customer this resolution date
      • setShowResolutionDateToCustomer

        public void setShowResolutionDateToCustomer​(java.lang.Boolean value)
        Setter for showResolutionDateToCustomer Indicator to show customer this resolution date
      • getClosedByUserId

        public java.lang.Integer getClosedByUserId()
        Getter for closedByUserId The unique ID number of the user that closed the notice
      • setClosedByUserId

        public void setClosedByUserId​(java.lang.Integer value)
        Setter for closedByUserId The unique ID number of the user that closed the notice
      • getCreatedByUserName

        public java.lang.String getCreatedByUserName()
        Getter for createdByUserName The user who created the notice
      • setCreatedByUserName

        public void setCreatedByUserName​(java.lang.String value)
        Setter for createdByUserName The user who created the notice
      • getOwnedByUserId

        public java.lang.Integer getOwnedByUserId()
        Getter for ownedByUserId The unique ID number of the user that owns the notice
      • setOwnedByUserId

        public void setOwnedByUserId​(java.lang.Integer value)
        Setter for ownedByUserId The unique ID number of the user that owns the notice
      • getDescription

        public java.lang.String getDescription()
        Getter for description The description of the notice
      • setDescription

        public void setDescription​(java.lang.String value)
        Setter for description The description of the notice
      • getAvaFileFormId

        public java.lang.Integer getAvaFileFormId()
        Getter for avaFileFormId The ava file form id of the notice
      • setAvaFileFormId

        public void setAvaFileFormId​(java.lang.Integer value)
        Setter for avaFileFormId The ava file form id of the notice
      • getRevenueContactId

        public java.lang.Integer getRevenueContactId()
        Getter for revenueContactId The id of the revenue contact
      • setRevenueContactId

        public void setRevenueContactId​(java.lang.Integer value)
        Setter for revenueContactId The id of the revenue contact
      • getComplianceContactId

        public java.lang.Integer getComplianceContactId()
        Getter for complianceContactId The id of the compliance contact
      • setComplianceContactId

        public void setComplianceContactId​(java.lang.Integer value)
        Setter for complianceContactId The id of the compliance contact
      • getTaxFormCode

        public java.lang.String getTaxFormCode()
        Getter for taxFormCode The tax form code of the notice
      • setTaxFormCode

        public void setTaxFormCode​(java.lang.String value)
        Setter for taxFormCode The tax form code of the notice
      • getDocumentReference

        public java.lang.String getDocumentReference()
        Getter for documentReference The document reference of the notice
      • setDocumentReference

        public void setDocumentReference​(java.lang.String value)
        Setter for documentReference The document reference of the notice
      • getJurisdictionName

        public java.lang.String getJurisdictionName()
        Getter for jurisdictionName The jurisdiction name of the notice
      • setJurisdictionName

        public void setJurisdictionName​(java.lang.String value)
        Setter for jurisdictionName The jurisdiction name of the notice
      • getJurisdictionType

        public java.lang.String getJurisdictionType()
        Getter for jurisdictionType The jurisdiction type of the notice
      • setJurisdictionType

        public void setJurisdictionType​(java.lang.String value)
        Setter for jurisdictionType The jurisdiction type of the notice
      • getComments

        public java.util.ArrayList<NoticeCommentModel> getComments()
        Getter for comments Additional comments on the notice
      • setComments

        public void setComments​(java.util.ArrayList<NoticeCommentModel> value)
        Setter for comments Additional comments on the notice
      • getFinances

        public java.util.ArrayList<NoticeFinanceModel> getFinances()
        Getter for finances Finance details of the notice
      • setFinances

        public void setFinances​(java.util.ArrayList<NoticeFinanceModel> value)
        Setter for finances Finance details of the notice
      • getResponsibility

        public java.util.ArrayList<NoticeResponsibilityDetailModel> getResponsibility()
        Getter for responsibility Notice Responsibility Details
      • setResponsibility

        public void setResponsibility​(java.util.ArrayList<NoticeResponsibilityDetailModel> value)
        Setter for responsibility Notice Responsibility Details
      • getRootCause

        public java.util.ArrayList<NoticeRootCauseDetailModel> getRootCause()
        Getter for rootCause Notice Root Cause Details
      • setRootCause

        public void setRootCause​(java.util.ArrayList<NoticeRootCauseDetailModel> value)
        Setter for rootCause Notice Root Cause Details
      • 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.
      • toString

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