Package Avalara.SDK.model.A1099.V2

Class W8BeneFormDataModel

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class W8BeneFormDataModel
extends Object
    W-8 BEN-E form

    • Constructor Detail

      • W8BeneFormDataModel

        public W8BeneFormDataModel()

    • Method Detail

      • getSignedDate

        @Nullable
public OffsetDateTime getSignedDate()
        The date the form was signed.
        Returns:
        signedDate

      • setSignedDate

        public void setSignedDate​(OffsetDateTime signedDate)

      • disregardedEntityChapter4FatcaStatus

        public W8BeneFormDataModel disregardedEntityChapter4FatcaStatus​(String disregardedEntityChapter4FatcaStatus)

      • getDisregardedEntityChapter4FatcaStatus

        @Nullable
public String getDisregardedEntityChapter4FatcaStatus()
        The FATCA status for disregarded entities under Chapter 4.
        Returns:
        disregardedEntityChapter4FatcaStatus

      • setDisregardedEntityChapter4FatcaStatus

        public void setDisregardedEntityChapter4FatcaStatus​(String disregardedEntityChapter4FatcaStatus)

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getName

        @Nullable
public String getName()
        The name of the individual or entity associated with the form.
        Returns:
        name

      • setName

        public void setName​(String name)

      • getResidenceAddress

        @Nullable
public String getResidenceAddress()
        The residential address of the individual or entity.
        Returns:
        residenceAddress

      • setResidenceAddress

        public void setResidenceAddress​(String residenceAddress)

      • getResidenceCity

        @Nullable
public String getResidenceCity()
        The city of residence.
        Returns:
        residenceCity

      • setResidenceCity

        public void setResidenceCity​(String residenceCity)

      • getResidenceState

        @Nullable
public String getResidenceState()
        The state of residence.
        Returns:
        residenceState

      • setResidenceState

        public void setResidenceState​(String residenceState)

      • getResidencePostalCode

        @Nullable
public String getResidencePostalCode()
        The postal code of the residence.
        Returns:
        residencePostalCode

      • setResidencePostalCode

        public void setResidencePostalCode​(String residencePostalCode)

      • getResidenceCountry

        @Nullable
public String getResidenceCountry()
        The country of residence.
        Returns:
        residenceCountry

      • setResidenceCountry

        public void setResidenceCountry​(String residenceCountry)

      • getMailingAddress

        @Nullable
public String getMailingAddress()
        The mailing address.
        Returns:
        mailingAddress

      • setMailingAddress

        public void setMailingAddress​(String mailingAddress)

      • getMailingCity

        @Nullable
public String getMailingCity()
        The city of the mailing address.
        Returns:
        mailingCity

      • setMailingCity

        public void setMailingCity​(String mailingCity)

      • getMailingState

        @Nullable
public String getMailingState()
        The state of the mailing address.
        Returns:
        mailingState

      • setMailingState

        public void setMailingState​(String mailingState)

      • getMailingPostalCode

        @Nullable
public String getMailingPostalCode()
        The postal code of the mailing address.
        Returns:
        mailingPostalCode

      • setMailingPostalCode

        public void setMailingPostalCode​(String mailingPostalCode)

      • getMailingCountry

        @Nullable
public String getMailingCountry()
        The country of the mailing address.
        Returns:
        mailingCountry

      • setMailingCountry

        public void setMailingCountry​(String mailingCountry)

      • getDisregardedAddress

        @Nullable
public String getDisregardedAddress()
        The address for disregarded entities.
        Returns:
        disregardedAddress

      • setDisregardedAddress

        public void setDisregardedAddress​(String disregardedAddress)

      • getDisregardedCity

        @Nullable
public String getDisregardedCity()
        The city for disregarded entities.
        Returns:
        disregardedCity

      • setDisregardedCity

        public void setDisregardedCity​(String disregardedCity)

      • getDisregardedState

        @Nullable
public String getDisregardedState()
        The state for disregarded entities.
        Returns:
        disregardedState

      • setDisregardedState

        public void setDisregardedState​(String disregardedState)

      • getDisregardedPostalCode

        @Nullable
public String getDisregardedPostalCode()
        The postal code for disregarded entities.
        Returns:
        disregardedPostalCode

      • setDisregardedPostalCode

        public void setDisregardedPostalCode​(String disregardedPostalCode)

      • getDisregardedCountry

        @Nullable
public String getDisregardedCountry()
        The country for disregarded entities.
        Returns:
        disregardedCountry

      • setDisregardedCountry

        public void setDisregardedCountry​(String disregardedCountry)

      • getTin

        @Nullable
public String getTin()
        The taxpayer identification number (TIN).
        Returns:
        tin

      • setTin

        public void setTin​(String tin)

      • getTypeOfTin

        @Nullable
public String getTypeOfTin()
        The type of TIN provided.
        Returns:
        typeOfTin

      • setTypeOfTin

        public void setTypeOfTin​(String typeOfTin)

      • getForeignTin

        @Nullable
public String getForeignTin()
        The foreign taxpayer identification number (TIN).
        Returns:
        foreignTin

      • setForeignTin

        public void setForeignTin​(String foreignTin)

      • getFtinNotRequired

        @Nullable
public Boolean getFtinNotRequired()
        Indicates whether a foreign TIN is not required.
        Returns:
        ftinNotRequired

      • setFtinNotRequired

        public void setFtinNotRequired​(Boolean ftinNotRequired)

      • getReferenceNumber

        @Nullable
public String getReferenceNumber()
        A reference number for the form.
        Returns:
        referenceNumber

      • setReferenceNumber

        public void setReferenceNumber​(String referenceNumber)

      • getGiin

        @Nullable
public String getGiin()
        The global intermediary identification number (GIIN).
        Returns:
        giin

      • setGiin

        public void setGiin​(String giin)

      • getChapter3EntityType

        @Nullable
public String getChapter3EntityType()
        The Chapter 3 entity type.
        Returns:
        chapter3EntityType

      • setChapter3EntityType

        public void setChapter3EntityType​(String chapter3EntityType)

      • getChapter4FatcaStatus

        @Nullable
public String getChapter4FatcaStatus()
        The Chapter 4 FATCA status.
        Returns:
        chapter4FatcaStatus

      • setChapter4FatcaStatus

        public void setChapter4FatcaStatus​(String chapter4FatcaStatus)

      • getDisregardedEntity

        @Nullable
public String getDisregardedEntity()
        The disregarded entity information.
        Returns:
        disregardedEntity

      • setDisregardedEntity

        public void setDisregardedEntity​(String disregardedEntity)

      • getDisregardedEntityGiin

        @Nullable
public String getDisregardedEntityGiin()
        The GIIN for disregarded entities.
        Returns:
        disregardedEntityGiin

      • setDisregardedEntityGiin

        public void setDisregardedEntityGiin​(String disregardedEntityGiin)

      • getBenefitLimitation

        @Nullable
public String getBenefitLimitation()
        The benefit limitation for tax treaty claims.
        Returns:
        benefitLimitation

      • setBenefitLimitation

        public void setBenefitLimitation​(String benefitLimitation)

      • getPart4SponsoringEntity

        @Nullable
public String getPart4SponsoringEntity()
        The sponsoring entity information for Part 4.
        Returns:
        part4SponsoringEntity

      • setPart4SponsoringEntity

        public void setPart4SponsoringEntity​(String part4SponsoringEntity)

      • getPart4SponsoringEntityGiin

        @Nullable
public String getPart4SponsoringEntityGiin()
        The GIIN for the sponsoring entity in Part 4.
        Returns:
        part4SponsoringEntityGiin

      • setPart4SponsoringEntityGiin

        public void setPart4SponsoringEntityGiin​(String part4SponsoringEntityGiin)

      • getPart7SponsoringEntity

        @Nullable
public String getPart7SponsoringEntity()
        The sponsoring entity information for Part 7.
        Returns:
        part7SponsoringEntity

      • setPart7SponsoringEntity

        public void setPart7SponsoringEntity​(String part7SponsoringEntity)

      • getPart12IgaCountry

        @Nullable
public String getPart12IgaCountry()
        The IGA country information for Part 12.
        Returns:
        part12IgaCountry

      • setPart12IgaCountry

        public void setPart12IgaCountry​(String part12IgaCountry)

      • getPart12IgaType

        @Nullable
public String getPart12IgaType()
        The IGA type information for Part 12.
        Returns:
        part12IgaType

      • setPart12IgaType

        public void setPart12IgaType​(String part12IgaType)

      • part12FatcaStatusUnderIgaAnnexIi

        public W8BeneFormDataModel part12FatcaStatusUnderIgaAnnexIi​(String part12FatcaStatusUnderIgaAnnexIi)

      • getPart12FatcaStatusUnderIgaAnnexIi

        @Nullable
public String getPart12FatcaStatusUnderIgaAnnexIi()
        The FATCA status under IGA Annex II for Part 12.
        Returns:
        part12FatcaStatusUnderIgaAnnexIi

      • setPart12FatcaStatusUnderIgaAnnexIi

        public void setPart12FatcaStatusUnderIgaAnnexIi​(String part12FatcaStatusUnderIgaAnnexIi)

      • getPart12TrusteeName

        @Nullable
public String getPart12TrusteeName()
        The trustee name for Part 12.
        Returns:
        part12TrusteeName

      • setPart12TrusteeName

        public void setPart12TrusteeName​(String part12TrusteeName)

      • getPart12TrusteeIsForeign

        @Nullable
public Boolean getPart12TrusteeIsForeign()
        Indicates whether the trustee is foreign for Part 12.
        Returns:
        part12TrusteeIsForeign

      • setPart12TrusteeIsForeign

        public void setPart12TrusteeIsForeign​(Boolean part12TrusteeIsForeign)

      • getPart12Model2IgaGiin

        @Nullable
public String getPart12Model2IgaGiin()
        The GIIN for Model 2 IGA in Part 12.
        Returns:
        part12Model2IgaGiin

      • setPart12Model2IgaGiin

        public void setPart12Model2IgaGiin​(String part12Model2IgaGiin)

      • getBox37AExchange

        @Nullable
public String getBox37AExchange()
        The exchange information for Box 37A.
        Returns:
        box37AExchange

      • setBox37AExchange

        public void setBox37AExchange​(String box37AExchange)

      • getBox37BExchange

        @Nullable
public String getBox37BExchange()
        The exchange information for Box 37B.
        Returns:
        box37BExchange

      • setBox37BExchange

        public void setBox37BExchange​(String box37BExchange)

      • getBox37BEntity

        @Nullable
public String getBox37BEntity()
        The entity information for Box 37B.
        Returns:
        box37BEntity

      • setBox37BEntity

        public void setBox37BEntity​(String box37BEntity)

      • getPart28SponsoringEntity

        @Nullable
public String getPart28SponsoringEntity()
        The sponsoring entity information for Part 28.
        Returns:
        part28SponsoringEntity

      • setPart28SponsoringEntity

        public void setPart28SponsoringEntity​(String part28SponsoringEntity)

      • getPart28SponsoringEntityGiin

        @Nullable
public String getPart28SponsoringEntityGiin()
        The GIIN for the sponsoring entity in Part 28.
        Returns:
        part28SponsoringEntityGiin

      • setPart28SponsoringEntityGiin

        public void setPart28SponsoringEntityGiin​(String part28SponsoringEntityGiin)

      • getSignerName

        @Nullable
public String getSignerName()
        The name of the signer.
        Returns:
        signerName

      • setSignerName

        public void setSignerName​(String signerName)

      • geteDeliveryConsentedAt

        @Nullable
public OffsetDateTime geteDeliveryConsentedAt()
        The date when e-delivery was consented.
        Returns:
        eDeliveryConsentedAt

      • seteDeliveryConsentedAt

        public void seteDeliveryConsentedAt​(OffsetDateTime eDeliveryConsentedAt)

      • getResidenceIsMailing

        @Nullable
public Boolean getResidenceIsMailing()
        Get residenceIsMailing
        Returns:
        residenceIsMailing

      • setResidenceIsMailing

        public void setResidenceIsMailing​(Boolean residenceIsMailing)

      • getCitizenshipCountry

        @Nullable
public String getCitizenshipCountry()
        Get citizenshipCountry
        Returns:
        citizenshipCountry

      • setCitizenshipCountry

        public void setCitizenshipCountry​(String citizenshipCountry)

      • getMakingTreatyClaim

        @Nullable
public Boolean getMakingTreatyClaim()
        Get makingTreatyClaim
        Returns:
        makingTreatyClaim

      • setMakingTreatyClaim

        public void setMakingTreatyClaim​(Boolean makingTreatyClaim)

      • getTreatyCountry

        @Nullable
public String getTreatyCountry()
        Get treatyCountry
        Returns:
        treatyCountry

      • setTreatyCountry

        public void setTreatyCountry​(String treatyCountry)

      • getTreatyArticle

        @Nullable
public String getTreatyArticle()
        Get treatyArticle
        Returns:
        treatyArticle

      • setTreatyArticle

        public void setTreatyArticle​(String treatyArticle)

      • getWithholdingRate

        @Nullable
public String getWithholdingRate()
        Get withholdingRate
        Returns:
        withholdingRate

      • setWithholdingRate

        public void setWithholdingRate​(String withholdingRate)

      • getIncomeType

        @Nullable
public String getIncomeType()
        Get incomeType
        Returns:
        incomeType

      • setIncomeType

        public void setIncomeType​(String incomeType)

      • getTreatyReasons

        @Nullable
public String getTreatyReasons()
        Get treatyReasons
        Returns:
        treatyReasons

      • setTreatyReasons

        public void setTreatyReasons​(String treatyReasons)

      • getCertifyBox14A

        @Nullable
public Boolean getCertifyBox14A()
        Get certifyBox14A
        Returns:
        certifyBox14A

      • setCertifyBox14A

        public void setCertifyBox14A​(Boolean certifyBox14A)

      • getCertifyBox14B

        @Nullable
public Boolean getCertifyBox14B()
        Get certifyBox14B
        Returns:
        certifyBox14B

      • setCertifyBox14B

        public void setCertifyBox14B​(Boolean certifyBox14B)

      • getCertifyBox14C

        @Nullable
public Boolean getCertifyBox14C()
        Get certifyBox14C
        Returns:
        certifyBox14C

      • setCertifyBox14C

        public void setCertifyBox14C​(Boolean certifyBox14C)

      • getCertifyBox171

        @Nullable
public Boolean getCertifyBox171()
        Get certifyBox171
        Returns:
        certifyBox171

      • setCertifyBox171

        public void setCertifyBox171​(Boolean certifyBox171)

      • getCertifyBox172

        @Nullable
public Boolean getCertifyBox172()
        Get certifyBox172
        Returns:
        certifyBox172

      • setCertifyBox172

        public void setCertifyBox172​(Boolean certifyBox172)

      • getCertifyBox18

        @Nullable
public Boolean getCertifyBox18()
        Get certifyBox18
        Returns:
        certifyBox18

      • setCertifyBox18

        public void setCertifyBox18​(Boolean certifyBox18)

      • getCertifyBox19

        @Nullable
public Boolean getCertifyBox19()
        Get certifyBox19
        Returns:
        certifyBox19

      • setCertifyBox19

        public void setCertifyBox19​(Boolean certifyBox19)

      • getCertifyBox21

        @Nullable
public Boolean getCertifyBox21()
        Get certifyBox21
        Returns:
        certifyBox21

      • setCertifyBox21

        public void setCertifyBox21​(Boolean certifyBox21)

      • getCertifyBox22

        @Nullable
public Boolean getCertifyBox22()
        Get certifyBox22
        Returns:
        certifyBox22

      • setCertifyBox22

        public void setCertifyBox22​(Boolean certifyBox22)

      • getCertifyBox23

        @Nullable
public Boolean getCertifyBox23()
        Get certifyBox23
        Returns:
        certifyBox23

      • setCertifyBox23

        public void setCertifyBox23​(Boolean certifyBox23)

      • getCertifyBox24A

        @Nullable
public Boolean getCertifyBox24A()
        Get certifyBox24A
        Returns:
        certifyBox24A

      • setCertifyBox24A

        public void setCertifyBox24A​(Boolean certifyBox24A)

      • getCertifyBox24B

        @Nullable
public Boolean getCertifyBox24B()
        Get certifyBox24B
        Returns:
        certifyBox24B

      • setCertifyBox24B

        public void setCertifyBox24B​(Boolean certifyBox24B)

      • getCertifyBox24C

        @Nullable
public Boolean getCertifyBox24C()
        Get certifyBox24C
        Returns:
        certifyBox24C

      • setCertifyBox24C

        public void setCertifyBox24C​(Boolean certifyBox24C)

      • getCertifyBox24D

        @Nullable
public Boolean getCertifyBox24D()
        Get certifyBox24D
        Returns:
        certifyBox24D

      • setCertifyBox24D

        public void setCertifyBox24D​(Boolean certifyBox24D)

      • getCertifyBox25A

        @Nullable
public Boolean getCertifyBox25A()
        Get certifyBox25A
        Returns:
        certifyBox25A

      • setCertifyBox25A

        public void setCertifyBox25A​(Boolean certifyBox25A)

      • getCertifyBox25B

        @Nullable
public Boolean getCertifyBox25B()
        Get certifyBox25B
        Returns:
        certifyBox25B

      • setCertifyBox25B

        public void setCertifyBox25B​(Boolean certifyBox25B)

      • getCertifyBox25C

        @Nullable
public Boolean getCertifyBox25C()
        Get certifyBox25C
        Returns:
        certifyBox25C

      • setCertifyBox25C

        public void setCertifyBox25C​(Boolean certifyBox25C)

      • getCertifyBox26

        @Nullable
public Boolean getCertifyBox26()
        Get certifyBox26
        Returns:
        certifyBox26

      • setCertifyBox26

        public void setCertifyBox26​(Boolean certifyBox26)

      • getCertifyBox27

        @Nullable
public Boolean getCertifyBox27()
        Get certifyBox27
        Returns:
        certifyBox27

      • setCertifyBox27

        public void setCertifyBox27​(Boolean certifyBox27)

      • getCertifyBox28A

        @Nullable
public Boolean getCertifyBox28A()
        Get certifyBox28A
        Returns:
        certifyBox28A

      • setCertifyBox28A

        public void setCertifyBox28A​(Boolean certifyBox28A)

      • getCertifyBox28B

        @Nullable
public Boolean getCertifyBox28B()
        Get certifyBox28B
        Returns:
        certifyBox28B

      • setCertifyBox28B

        public void setCertifyBox28B​(Boolean certifyBox28B)

      • getCertifyBox29A

        @Nullable
public Boolean getCertifyBox29A()
        Get certifyBox29A
        Returns:
        certifyBox29A

      • setCertifyBox29A

        public void setCertifyBox29A​(Boolean certifyBox29A)

      • getCertifyBox29B

        @Nullable
public Boolean getCertifyBox29B()
        Get certifyBox29B
        Returns:
        certifyBox29B

      • setCertifyBox29B

        public void setCertifyBox29B​(Boolean certifyBox29B)

      • getCertifyBox29C

        @Nullable
public Boolean getCertifyBox29C()
        Get certifyBox29C
        Returns:
        certifyBox29C

      • setCertifyBox29C

        public void setCertifyBox29C​(Boolean certifyBox29C)

      • getCertifyBox29D

        @Nullable
public Boolean getCertifyBox29D()
        Get certifyBox29D
        Returns:
        certifyBox29D

      • setCertifyBox29D

        public void setCertifyBox29D​(Boolean certifyBox29D)

      • getCertifyBox29E

        @Nullable
public Boolean getCertifyBox29E()
        Get certifyBox29E
        Returns:
        certifyBox29E

      • setCertifyBox29E

        public void setCertifyBox29E​(Boolean certifyBox29E)

      • getCertifyBox29F

        @Nullable
public Boolean getCertifyBox29F()
        Get certifyBox29F
        Returns:
        certifyBox29F

      • setCertifyBox29F

        public void setCertifyBox29F​(Boolean certifyBox29F)

      • getCertifyBox30

        @Nullable
public Boolean getCertifyBox30()
        Get certifyBox30
        Returns:
        certifyBox30

      • setCertifyBox30

        public void setCertifyBox30​(Boolean certifyBox30)

      • getCertifyBox31

        @Nullable
public Boolean getCertifyBox31()
        Get certifyBox31
        Returns:
        certifyBox31

      • setCertifyBox31

        public void setCertifyBox31​(Boolean certifyBox31)

      • getCertifyBox32

        @Nullable
public Boolean getCertifyBox32()
        Get certifyBox32
        Returns:
        certifyBox32

      • setCertifyBox32

        public void setCertifyBox32​(Boolean certifyBox32)

      • getCertifyBox33

        @Nullable
public Boolean getCertifyBox33()
        Get certifyBox33
        Returns:
        certifyBox33

      • setCertifyBox33

        public void setCertifyBox33​(Boolean certifyBox33)

      • getCertifyBox34

        @Nullable
public Boolean getCertifyBox34()
        Get certifyBox34
        Returns:
        certifyBox34

      • setCertifyBox34

        public void setCertifyBox34​(Boolean certifyBox34)

      • getCertifyBox35

        @Nullable
public Boolean getCertifyBox35()
        Get certifyBox35
        Returns:
        certifyBox35

      • setCertifyBox35

        public void setCertifyBox35​(Boolean certifyBox35)

      • getCertifyBox36

        @Nullable
public Boolean getCertifyBox36()
        Get certifyBox36
        Returns:
        certifyBox36

      • setCertifyBox36

        public void setCertifyBox36​(Boolean certifyBox36)

      • getCertifyBox37A

        @Nullable
public Boolean getCertifyBox37A()
        Get certifyBox37A
        Returns:
        certifyBox37A

      • setCertifyBox37A

        public void setCertifyBox37A​(Boolean certifyBox37A)

      • getCertifyBox37B

        @Nullable
public Boolean getCertifyBox37B()
        Get certifyBox37B
        Returns:
        certifyBox37B

      • setCertifyBox37B

        public void setCertifyBox37B​(Boolean certifyBox37B)

      • getCertifyBox38

        @Nullable
public Boolean getCertifyBox38()
        Get certifyBox38
        Returns:
        certifyBox38

      • setCertifyBox38

        public void setCertifyBox38​(Boolean certifyBox38)

      • getCertifyBox39

        @Nullable
public Boolean getCertifyBox39()
        Get certifyBox39
        Returns:
        certifyBox39

      • setCertifyBox39

        public void setCertifyBox39​(Boolean certifyBox39)

      • getCertifyBox40A

        @Nullable
public Boolean getCertifyBox40A()
        Get certifyBox40A
        Returns:
        certifyBox40A

      • setCertifyBox40A

        public void setCertifyBox40A​(Boolean certifyBox40A)

      • getCertifyBox40B

        @Nullable
public Boolean getCertifyBox40B()
        Get certifyBox40B
        Returns:
        certifyBox40B

      • setCertifyBox40B

        public void setCertifyBox40B​(Boolean certifyBox40B)

      • getCertifyBox40C

        @Nullable
public Boolean getCertifyBox40C()
        Get certifyBox40C
        Returns:
        certifyBox40C

      • setCertifyBox40C

        public void setCertifyBox40C​(Boolean certifyBox40C)

      • getCertifyBox41

        @Nullable
public Boolean getCertifyBox41()
        Get certifyBox41
        Returns:
        certifyBox41

      • setCertifyBox41

        public void setCertifyBox41​(Boolean certifyBox41)

      • getCertifyBox43

        @Nullable
public Boolean getCertifyBox43()
        Get certifyBox43
        Returns:
        certifyBox43

      • setCertifyBox43

        public void setCertifyBox43​(Boolean certifyBox43)

      • getCertifyPart29Signature

        @Nullable
public Boolean getCertifyPart29Signature()
        Get certifyPart29Signature
        Returns:
        certifyPart29Signature

      • setCertifyPart29Signature

        public void setCertifyPart29Signature​(Boolean certifyPart29Signature)

      • part19FormationOrResolutionDate

        public W8BeneFormDataModel part19FormationOrResolutionDate​(LocalDate part19FormationOrResolutionDate)

      • getPart19FormationOrResolutionDate

        @Nullable
public LocalDate getPart19FormationOrResolutionDate()
        Get part19FormationOrResolutionDate
        Returns:
        part19FormationOrResolutionDate

      • setPart19FormationOrResolutionDate

        public void setPart19FormationOrResolutionDate​(LocalDate part19FormationOrResolutionDate)

      • getPart20FilingDate

        @Nullable
public LocalDate getPart20FilingDate()
        Get part20FilingDate
        Returns:
        part20FilingDate

      • setPart20FilingDate

        public void setPart20FilingDate​(LocalDate part20FilingDate)

      • getPart21DeterminationDate

        @Nullable
public LocalDate getPart21DeterminationDate()
        Get part21DeterminationDate
        Returns:
        part21DeterminationDate

      • setPart21DeterminationDate

        public void setPart21DeterminationDate​(LocalDate part21DeterminationDate)

      • getEmployeeFirstName

        @Nullable
public String getEmployeeFirstName()
        The first name of the employee.
        Returns:
        employeeFirstName

      • setEmployeeFirstName

        public void setEmployeeFirstName​(String employeeFirstName)

      • getEmployeeMiddleName

        @Nullable
public String getEmployeeMiddleName()
        The middle name of the employee.
        Returns:
        employeeMiddleName

      • setEmployeeMiddleName

        public void setEmployeeMiddleName​(String employeeMiddleName)

      • getEmployeeLastName

        @Nullable
public String getEmployeeLastName()
        The last name of the employee.
        Returns:
        employeeLastName

      • setEmployeeLastName

        public void setEmployeeLastName​(String employeeLastName)

      • getEmployeeNameSuffix

        @Nullable
public String getEmployeeNameSuffix()
        The name suffix of the employee.
        Returns:
        employeeNameSuffix

      • setEmployeeNameSuffix

        public void setEmployeeNameSuffix​(String employeeNameSuffix)

      • getAddress

        @Nullable
public String getAddress()
        The address of the individual or entity.
        Returns:
        address

      • setAddress

        public void setAddress​(String address)

      • getCity

        @Nullable
public String getCity()
        The city of the address.
        Returns:
        city

      • setCity

        public void setCity​(String city)

      • getState

        @Nullable
public String getState()
        The state of the address.
        Returns:
        state

      • setState

        public void setState​(String state)

      • getZip

        @Nullable
public String getZip()
        The ZIP code of the address.
        Returns:
        zip

      • setZip

        public void setZip​(String zip)

      • getBox3MaritalStatus

        @Nullable
public String getBox3MaritalStatus()
        The marital status of the employee.
        Returns:
        box3MaritalStatus

      • setBox3MaritalStatus

        public void setBox3MaritalStatus​(String box3MaritalStatus)

      • getBox4LastNameDiffers

        @Nullable
public Boolean getBox4LastNameDiffers()
        Indicates whether the last name differs from prior records.
        Returns:
        box4LastNameDiffers

      • setBox4LastNameDiffers

        public void setBox4LastNameDiffers​(Boolean box4LastNameDiffers)

      • getBox5NumAllowances

        @Nullable
public Integer getBox5NumAllowances()
        The number of allowances claimed by the employee.
        Returns:
        box5NumAllowances

      • setBox5NumAllowances

        public void setBox5NumAllowances​(Integer box5NumAllowances)

      • getOtherDependents

        @Nullable
public Integer getOtherDependents()
        The number of dependents other than allowances.
        Returns:
        otherDependents

      • setOtherDependents

        public void setOtherDependents​(Integer otherDependents)

      • getNonJobIncome

        @Nullable
public Double getNonJobIncome()
        The amount of non-job income.
        Returns:
        nonJobIncome

      • setNonJobIncome

        public void setNonJobIncome​(Double nonJobIncome)

      • getDeductions

        @Nullable
public Double getDeductions()
        The amount of deductions claimed.
        Returns:
        deductions

      • setDeductions

        public void setDeductions​(Double deductions)

      • getBox6AdditionalWithheld

        @Nullable
public Double getBox6AdditionalWithheld()
        The additional amount withheld.
        Returns:
        box6AdditionalWithheld

      • setBox6AdditionalWithheld

        public void setBox6AdditionalWithheld​(Double box6AdditionalWithheld)

      • getBox7ExemptFromWithholding

        @Nullable
public Boolean getBox7ExemptFromWithholding()
        Indicates whether the employee is exempt from withholding.
        Returns:
        box7ExemptFromWithholding

      • setBox7ExemptFromWithholding

        public void setBox7ExemptFromWithholding​(Boolean box7ExemptFromWithholding)

      • getOfficeCode

        @Nullable
public String getOfficeCode()
        The office code associated with the form.
        Returns:
        officeCode

      • setOfficeCode

        public void setOfficeCode​(String officeCode)

      • getBirthday

        @Nullable
public String getBirthday()
        The birthday of the individual associated with the form.
        Returns:
        birthday

      • setBirthday

        public void setBirthday​(String birthday)

      • getForeignTinNotRequired

        @Nullable
public Boolean getForeignTinNotRequired()
        Indicates whether a foreign TIN is not required.
        Returns:
        foreignTinNotRequired

      • setForeignTinNotRequired

        public void setForeignTinNotRequired​(Boolean foreignTinNotRequired)

      • getArchived

        @Nullable
public Boolean getArchived()
        Indicates whether the form is archived.
        Returns:
        archived

      • setArchived

        public void setArchived​(Boolean archived)

      • getReferenceId

        @Nullable
public String getReferenceId()
        A reference identifier for the form.
        Returns:
        referenceId

      • setReferenceId

        public void setReferenceId​(String referenceId)

      • getCompanyId

        @Nullable
public Integer getCompanyId()
        The ID of the associated company.
        Returns:
        companyId

      • setCompanyId

        public void setCompanyId​(Integer companyId)

      • getDisplayName

        @Nullable
public String getDisplayName()
        The display name associated with the form.
        Returns:
        displayName

      • setDisplayName

        public void setDisplayName​(String displayName)

      • getEmail

        @Nullable
public String getEmail()
        The email address of the individual associated with the form.
        Returns:
        email

      • setEmail

        public void setEmail​(String email)

      • getSignerCapacity

        @Nullable
public String getSignerCapacity()
        The capacity in which the signer is signing the form.
        Returns:
        signerCapacity

      • setSignerCapacity

        public void setSignerCapacity​(String signerCapacity)

      • getUpdatedAt

        @Nullable
public OffsetDateTime getUpdatedAt()
        The last updated date of the form.
        Returns:
        updatedAt

      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)

      • getEin

        @Nullable
public String getEin()
        The employer identification number (EIN).
        Returns:
        ein

      • setEin

        public void setEin​(String ein)

      • getEinType

        @Nullable
public String getEinType()
        The type of employer identification number (EIN).
        Returns:
        einType

      • setEinType

        public void setEinType​(String einType)

      • getCertifyBox14

        @Nullable
public Boolean getCertifyBox14()
        Indicates certification for box 14.
        Returns:
        certifyBox14

      • setCertifyBox14

        public void setCertifyBox14​(Boolean certifyBox14)

      • getCertifyBox15A

        @Nullable
public Boolean getCertifyBox15A()
        Indicates certification for box 15A.
        Returns:
        certifyBox15A

      • setCertifyBox15A

        public void setCertifyBox15A​(Boolean certifyBox15A)

      • getCertifyBox15B

        @Nullable
public Boolean getCertifyBox15B()
        Indicates certification for box 15B.
        Returns:
        certifyBox15B

      • setCertifyBox15B

        public void setCertifyBox15B​(Boolean certifyBox15B)

      • getCertifyBox15C

        @Nullable
public Boolean getCertifyBox15C()
        Indicates certification for box 15C.
        Returns:
        certifyBox15C

      • setCertifyBox15C

        public void setCertifyBox15C​(Boolean certifyBox15C)

      • getCertifyBox15D

        @Nullable
public Boolean getCertifyBox15D()
        Indicates certification for box 15D.
        Returns:
        certifyBox15D

      • setCertifyBox15D

        public void setCertifyBox15D​(Boolean certifyBox15D)

      • getCertifyBox15E

        @Nullable
public Boolean getCertifyBox15E()
        Indicates certification for box 15E.
        Returns:
        certifyBox15E

      • setCertifyBox15E

        public void setCertifyBox15E​(Boolean certifyBox15E)

      • getCertifyBox15F

        @Nullable
public Boolean getCertifyBox15F()
        Indicates certification for box 15F.
        Returns:
        certifyBox15F

      • setCertifyBox15F

        public void setCertifyBox15F​(Boolean certifyBox15F)

      • getCertifyBox15G

        @Nullable
public Boolean getCertifyBox15G()
        Indicates certification for box 15G.
        Returns:
        certifyBox15G

      • setCertifyBox15G

        public void setCertifyBox15G​(Boolean certifyBox15G)

      • getCertifyBox15H

        @Nullable
public Boolean getCertifyBox15H()
        Indicates certification for box 15H.
        Returns:
        certifyBox15H

      • setCertifyBox15H

        public void setCertifyBox15H​(Boolean certifyBox15H)

      • getCertifyBox15I

        @Nullable
public Boolean getCertifyBox15I()
        Indicates certification for box 15I.
        Returns:
        certifyBox15I

      • setCertifyBox15I

        public void setCertifyBox15I​(Boolean certifyBox15I)

      • getCertifyBox16A

        @Nullable
public Boolean getCertifyBox16A()
        Indicates certification for box 16A.
        Returns:
        certifyBox16A

      • setCertifyBox16A

        public void setCertifyBox16A​(Boolean certifyBox16A)

      • getBox16BQddCorporate

        @Nullable
public Boolean getBox16BQddCorporate()
        Indicates certification for box 16B as a QDD corporate entity.
        Returns:
        box16BQddCorporate

      • setBox16BQddCorporate

        public void setBox16BQddCorporate​(Boolean box16BQddCorporate)

      • getBox16BQddPartnership

        @Nullable
public Boolean getBox16BQddPartnership()
        Indicates certification for box 16B as a QDD partnership.
        Returns:
        box16BQddPartnership

      • setBox16BQddPartnership

        public void setBox16BQddPartnership​(Boolean box16BQddPartnership)

      • getBox16BQddDisregardedEntity

        @Nullable
public Boolean getBox16BQddDisregardedEntity()
        Indicates certification for box 16B as a QDD disregarded entity.
        Returns:
        box16BQddDisregardedEntity

      • setBox16BQddDisregardedEntity

        public void setBox16BQddDisregardedEntity​(Boolean box16BQddDisregardedEntity)

      • getCertifyBox17A

        @Nullable
public Boolean getCertifyBox17A()
        Indicates certification for box 17A.
        Returns:
        certifyBox17A

      • setCertifyBox17A

        public void setCertifyBox17A​(Boolean certifyBox17A)

      • getCertifyBox17B

        @Nullable
public Boolean getCertifyBox17B()
        Indicates certification for box 17B.
        Returns:
        certifyBox17B

      • setCertifyBox17B

        public void setCertifyBox17B​(Boolean certifyBox17B)

      • getCertifyBox17C

        @Nullable
public Boolean getCertifyBox17C()
        Indicates certification for box 17C.
        Returns:
        certifyBox17C

      • setCertifyBox17C

        public void setCertifyBox17C​(Boolean certifyBox17C)

      • getCertifyBox17D

        @Nullable
public Boolean getCertifyBox17D()
        Indicates certification for box 17D.
        Returns:
        certifyBox17D

      • setCertifyBox17D

        public void setCertifyBox17D​(Boolean certifyBox17D)

      • getCertifyBox17E

        @Nullable
public Boolean getCertifyBox17E()
        Indicates certification for box 17E.
        Returns:
        certifyBox17E

      • setCertifyBox17E

        public void setCertifyBox17E​(Boolean certifyBox17E)

      • getCertifyBox18A

        @Nullable
public Boolean getCertifyBox18A()
        Indicates certification for box 18A.
        Returns:
        certifyBox18A

      • setCertifyBox18A

        public void setCertifyBox18A​(Boolean certifyBox18A)

      • getCertifyBox18B

        @Nullable
public Boolean getCertifyBox18B()
        Indicates certification for box 18B.
        Returns:
        certifyBox18B

      • setCertifyBox18B

        public void setCertifyBox18B​(Boolean certifyBox18B)

      • getCertifyBox18C

        @Nullable
public Boolean getCertifyBox18C()
        Indicates certification for box 18C.
        Returns:
        certifyBox18C

      • setCertifyBox18C

        public void setCertifyBox18C​(Boolean certifyBox18C)

      • getCertifyBox18D

        @Nullable
public Boolean getCertifyBox18D()
        Indicates certification for box 18D.
        Returns:
        certifyBox18D

      • setCertifyBox18D

        public void setCertifyBox18D​(Boolean certifyBox18D)

      • getCertifyBox18E

        @Nullable
public Boolean getCertifyBox18E()
        Indicates certification for box 18E.
        Returns:
        certifyBox18E

      • setCertifyBox18E

        public void setCertifyBox18E​(Boolean certifyBox18E)

      • getCertifyBox18F

        @Nullable
public Boolean getCertifyBox18F()
        Indicates certification for box 18F.
        Returns:
        certifyBox18F

      • setCertifyBox18F

        public void setCertifyBox18F​(Boolean certifyBox18F)

      • getCertifyBox19A

        @Nullable
public Boolean getCertifyBox19A()
        Indicates certification for box 19A.
        Returns:
        certifyBox19A

      • setCertifyBox19A

        public void setCertifyBox19A​(Boolean certifyBox19A)

      • getCertifyBox19B

        @Nullable
public Boolean getCertifyBox19B()
        Indicates certification for box 19B.
        Returns:
        certifyBox19B

      • setCertifyBox19B

        public void setCertifyBox19B​(Boolean certifyBox19B)

      • getCertifyBox19C

        @Nullable
public Boolean getCertifyBox19C()
        Indicates certification for box 19C.
        Returns:
        certifyBox19C

      • setCertifyBox19C

        public void setCertifyBox19C​(Boolean certifyBox19C)

      • getCertifyBox19D

        @Nullable
public Boolean getCertifyBox19D()
        Indicates certification for box 19D.
        Returns:
        certifyBox19D

      • setCertifyBox19D

        public void setCertifyBox19D​(Boolean certifyBox19D)

      • getCertifyBox19E

        @Nullable
public Boolean getCertifyBox19E()
        Indicates certification for box 19E.
        Returns:
        certifyBox19E

      • setCertifyBox19E

        public void setCertifyBox19E​(Boolean certifyBox19E)

      • getCertifyBox19F

        @Nullable
public Boolean getCertifyBox19F()
        Indicates certification for box 19F.
        Returns:
        certifyBox19F

      • setCertifyBox19F

        public void setCertifyBox19F​(Boolean certifyBox19F)

      • getCertifyBox20

        @Nullable
public Boolean getCertifyBox20()
        Indicates certification for box 20.
        Returns:
        certifyBox20

      • setCertifyBox20

        public void setCertifyBox20​(Boolean certifyBox20)

      • getCertifyBox21A

        @Nullable
public Boolean getCertifyBox21A()
        Indicates certification for box 21A.
        Returns:
        certifyBox21A

      • setCertifyBox21A

        public void setCertifyBox21A​(Boolean certifyBox21A)

      • getCertifyBox21B

        @Nullable
public Boolean getCertifyBox21B()
        Indicates certification for box 21B.
        Returns:
        certifyBox21B

      • setCertifyBox21B

        public void setCertifyBox21B​(Boolean certifyBox21B)

      • getCertifyBox21C

        @Nullable
public Boolean getCertifyBox21C()
        Indicates certification for box 21C.
        Returns:
        certifyBox21C

      • setCertifyBox21C

        public void setCertifyBox21C​(Boolean certifyBox21C)

      • getCertifyBox21D

        @Nullable
public Boolean getCertifyBox21D()
        Indicates certification for box 21D.
        Returns:
        certifyBox21D

      • setCertifyBox21D

        public void setCertifyBox21D​(Boolean certifyBox21D)

      • getCertifyBox21E

        @Nullable
public Boolean getCertifyBox21E()
        Indicates certification for box 21E.
        Returns:
        certifyBox21E

      • setCertifyBox21E

        public void setCertifyBox21E​(Boolean certifyBox21E)

      • getCertifyBox21F

        @Nullable
public Boolean getCertifyBox21F()
        Indicates certification for box 21F.
        Returns:
        certifyBox21F

      • setCertifyBox21F

        public void setCertifyBox21F​(Boolean certifyBox21F)

      • getBox23ANameSponsoringEntity

        @Nullable
public String getBox23ANameSponsoringEntity()
        The name of the sponsoring entity for box 23A.
        Returns:
        box23ANameSponsoringEntity

      • setBox23ANameSponsoringEntity

        public void setBox23ANameSponsoringEntity​(String box23ANameSponsoringEntity)

      • getCertifyBox23B

        @Nullable
public Boolean getCertifyBox23B()
        Indicates certification for box 23B.
        Returns:
        certifyBox23B

      • setCertifyBox23B

        public void setCertifyBox23B​(Boolean certifyBox23B)

      • getCertifyBox23C

        @Nullable
public Boolean getCertifyBox23C()
        Indicates certification for box 23C.
        Returns:
        certifyBox23C

      • setCertifyBox23C

        public void setCertifyBox23C​(Boolean certifyBox23C)

      • getCertifyBox25

        @Nullable
public Boolean getCertifyBox25()
        Indicates certification for box 25.
        Returns:
        certifyBox25

      • setCertifyBox25

        public void setCertifyBox25​(Boolean certifyBox25)

      • getBox27ANameSponsoringEntity

        @Nullable
public String getBox27ANameSponsoringEntity()
        The name of the sponsoring entity for box 27A.
        Returns:
        box27ANameSponsoringEntity

      • setBox27ANameSponsoringEntity

        public void setBox27ANameSponsoringEntity​(String box27ANameSponsoringEntity)

      • getCertifyBox27B

        @Nullable
public Boolean getCertifyBox27B()
        Indicates certification for box 27B.
        Returns:
        certifyBox27B

      • setCertifyBox27B

        public void setCertifyBox27B​(Boolean certifyBox27B)

      • getCertifyBox28

        @Nullable
public Boolean getCertifyBox28()
        Indicates certification for box 28.
        Returns:
        certifyBox28

      • setCertifyBox28

        public void setCertifyBox28​(Boolean certifyBox28)

      • getCertifyBox29

        @Nullable
public Boolean getCertifyBox29()
        Indicates certification for box 29.
        Returns:
        certifyBox29

      • setCertifyBox29

        public void setCertifyBox29​(Boolean certifyBox29)

      • getCertifyBox30A

        @Nullable
public Boolean getCertifyBox30A()
        Indicates certification for box 30A.
        Returns:
        certifyBox30A

      • setCertifyBox30A

        public void setCertifyBox30A​(Boolean certifyBox30A)

      • getCertifyBox30B

        @Nullable
public Boolean getCertifyBox30B()
        Indicates certification for box 30B.
        Returns:
        certifyBox30B

      • setCertifyBox30B

        public void setCertifyBox30B​(Boolean certifyBox30B)

      • getCertifyBox30C

        @Nullable
public Boolean getCertifyBox30C()
        Indicates certification for box 30C.
        Returns:
        certifyBox30C

      • setCertifyBox30C

        public void setCertifyBox30C​(Boolean certifyBox30C)

      • getBox32IgaCountry

        @Nullable
public String getBox32IgaCountry()
        The IGA country information for box 32.
        Returns:
        box32IgaCountry

      • setBox32IgaCountry

        public void setBox32IgaCountry​(String box32IgaCountry)

      • getBox32IgaType

        @Nullable
public String getBox32IgaType()
        The IGA type information for box 32.
        Returns:
        box32IgaType

      • setBox32IgaType

        public void setBox32IgaType​(String box32IgaType)

      • getBox32IgaTreatedAs

        @Nullable
public String getBox32IgaTreatedAs()
        The IGA treatment information for box 32.
        Returns:
        box32IgaTreatedAs

      • setBox32IgaTreatedAs

        public void setBox32IgaTreatedAs​(String box32IgaTreatedAs)

      • getBox32TrusteeOrSponsor

        @Nullable
public String getBox32TrusteeOrSponsor()
        The trustee or sponsor information for box 32.
        Returns:
        box32TrusteeOrSponsor

      • setBox32TrusteeOrSponsor

        public void setBox32TrusteeOrSponsor​(String box32TrusteeOrSponsor)

      • getBox32TrusteeIsForeign

        @Nullable
public Boolean getBox32TrusteeIsForeign()
        Indicates whether the trustee is foreign for box 32.
        Returns:
        box32TrusteeIsForeign

      • setBox32TrusteeIsForeign

        public void setBox32TrusteeIsForeign​(Boolean box32TrusteeIsForeign)

      • getCertifyBox33A

        @Nullable
public Boolean getCertifyBox33A()
        Indicates certification for box 33A.
        Returns:
        certifyBox33A

      • setCertifyBox33A

        public void setCertifyBox33A​(Boolean certifyBox33A)

      • getCertifyBox33B

        @Nullable
public Boolean getCertifyBox33B()
        Indicates certification for box 33B.
        Returns:
        certifyBox33B

      • setCertifyBox33B

        public void setCertifyBox33B​(Boolean certifyBox33B)

      • getCertifyBox33C

        @Nullable
public Boolean getCertifyBox33C()
        Indicates certification for box 33C.
        Returns:
        certifyBox33C

      • setCertifyBox33C

        public void setCertifyBox33C​(Boolean certifyBox33C)

      • getCertifyBox33D

        @Nullable
public Boolean getCertifyBox33D()
        Indicates certification for box 33D.
        Returns:
        certifyBox33D

      • setCertifyBox33D

        public void setCertifyBox33D​(Boolean certifyBox33D)

      • getCertifyBox33E

        @Nullable
public Boolean getCertifyBox33E()
        Indicates certification for box 33E.
        Returns:
        certifyBox33E

      • setCertifyBox33E

        public void setCertifyBox33E​(Boolean certifyBox33E)

      • getCertifyBox33F

        @Nullable
public Boolean getCertifyBox33F()
        Indicates certification for box 33F.
        Returns:
        certifyBox33F

      • setCertifyBox33F

        public void setCertifyBox33F​(Boolean certifyBox33F)

      • getBox37ASecuritiesMarket

        @Nullable
public String getBox37ASecuritiesMarket()
        The securities market information for box 37A.
        Returns:
        box37ASecuritiesMarket

      • setBox37ASecuritiesMarket

        public void setBox37ASecuritiesMarket​(String box37ASecuritiesMarket)

      • getBox37BNameOfEntity

        @Nullable
public String getBox37BNameOfEntity()
        The name of the entity for box 37B.
        Returns:
        box37BNameOfEntity

      • setBox37BNameOfEntity

        public void setBox37BNameOfEntity​(String box37BNameOfEntity)

      • getBox37BSecuritiesMarket

        @Nullable
public String getBox37BSecuritiesMarket()
        The securities market information for box 37B.
        Returns:
        box37BSecuritiesMarket

      • setBox37BSecuritiesMarket

        public void setBox37BSecuritiesMarket​(String box37BSecuritiesMarket)

      • getCertifyBox40

        @Nullable
public Boolean getCertifyBox40()
        Indicates certification for box 40.
        Returns:
        certifyBox40

      • setCertifyBox40

        public void setCertifyBox40​(Boolean certifyBox40)

      • getBox41SponsoringEntity

        @Nullable
public String getBox41SponsoringEntity()
        The sponsoring entity information for box 41.
        Returns:
        box41SponsoringEntity

      • setBox41SponsoringEntity

        public void setBox41SponsoringEntity​(String box41SponsoringEntity)

      • getCertifyBox42

        @Nullable
public Boolean getCertifyBox42()
        Indicates certification for box 42.
        Returns:
        certifyBox42

      • setCertifyBox42

        public void setCertifyBox42​(Boolean certifyBox42)

      • getBox35FormedOnDate

        @Nullable
public LocalDate getBox35FormedOnDate()
        Get box35FormedOnDate
        Returns:
        box35FormedOnDate

      • setBox35FormedOnDate

        public void setBox35FormedOnDate​(LocalDate box35FormedOnDate)

      • getBox36FiledOnDate

        @Nullable
public LocalDate getBox36FiledOnDate()
        Get box36FiledOnDate
        Returns:
        box36FiledOnDate

      • setBox36FiledOnDate

        public void setBox36FiledOnDate​(LocalDate box36FiledOnDate)

      • getTinMatchStatus

        @Nullable
public String getTinMatchStatus()
        The status of the TIN match.
        Returns:
        tinMatchStatus

      • setTinMatchStatus

        public void setTinMatchStatus​(String tinMatchStatus)

      • getSignature

        @Nullable
public String getSignature()
        The signature itself
        Returns:
        signature

      • setSignature

        public void setSignature​(String signature)

      • getBusinessClassification

        @Nullable
public String getBusinessClassification()
        The classification of the business.
        Returns:
        businessClassification

      • setBusinessClassification

        public void setBusinessClassification​(String businessClassification)

      • getBusinessName

        @Nullable
public String getBusinessName()
        The name of the business associated with the form.
        Returns:
        businessName

      • setBusinessName

        public void setBusinessName​(String businessName)

      • getBusinessOther

        @Nullable
public String getBusinessOther()
        Get businessOther
        Returns:
        businessOther

      • setBusinessOther

        public void setBusinessOther​(String businessOther)

      • getExemptPayeeCode

        @Nullable
public String getExemptPayeeCode()
        Get exemptPayeeCode
        Returns:
        exemptPayeeCode

      • setExemptPayeeCode

        public void setExemptPayeeCode​(String exemptPayeeCode)

      • getExemptFatcaCode

        @Nullable
public String getExemptFatcaCode()
        Get exemptFatcaCode
        Returns:
        exemptFatcaCode

      • setExemptFatcaCode

        public void setExemptFatcaCode​(String exemptFatcaCode)

      • getAccountNumber

        @Nullable
public String getAccountNumber()
        The account number associated with the form.
        Returns:
        accountNumber

      • setAccountNumber

        public void setAccountNumber​(String accountNumber)

      • getForeignCountryIndicator

        @Nullable
public Boolean getForeignCountryIndicator()
        Indicates whether the individual or entity is in a foreign country.
        Returns:
        foreignCountryIndicator

      • setForeignCountryIndicator

        public void setForeignCountryIndicator​(Boolean foreignCountryIndicator)

      • getForeignAddress

        @Nullable
public String getForeignAddress()
        The foreign address of the individual or entity.
        Returns:
        foreignAddress

      • setForeignAddress

        public void setForeignAddress​(String foreignAddress)

      • getBackupWithholding

        @Nullable
public Boolean getBackupWithholding()
        Indicates whether backup withholding applies.
        Returns:
        backupWithholding

      • setBackupWithholding

        public void setBackupWithholding​(Boolean backupWithholding)

      • getIs1099able

        @Nullable
public Boolean getIs1099able()
        Get is1099able
        Returns:
        is1099able

      • setIs1099able

        public void setIs1099able​(Boolean is1099able)

      • foreignPartnerOwnerOrBeneficiary

        public W8BeneFormDataModel foreignPartnerOwnerOrBeneficiary​(Boolean foreignPartnerOwnerOrBeneficiary)

      • getForeignPartnerOwnerOrBeneficiary

        @Nullable
public Boolean getForeignPartnerOwnerOrBeneficiary()
        Indicates whether the individual is a foreign partner, owner, or beneficiary.
        Returns:
        foreignPartnerOwnerOrBeneficiary

      • setForeignPartnerOwnerOrBeneficiary

        public void setForeignPartnerOwnerOrBeneficiary​(Boolean foreignPartnerOwnerOrBeneficiary)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to W8BeneFormDataModel

      • fromJson

        public static W8BeneFormDataModel fromJson​(String jsonString)
                                    throws IOException
        Create an instance of W8BeneFormDataModel given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of W8BeneFormDataModel
        Throws:
        IOException - if the JSON string is invalid with respect to W8BeneFormDataModel

      • toJson

        public String toJson()
        Convert an instance of W8BeneFormDataModel to an JSON string
        Returns:
        JSON string