Package Avalara.SDK.model.A1099.V2

Class W8BenFormRequest

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class W8BenFormRequest
extends Object
    W8BenFormRequest

    • Constructor Detail

      • W8BenFormRequest

        public W8BenFormRequest()

    • Method Detail

      • getName

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

      • setName

        public void setName​(String name)

      • getCitizenshipCountry

        @Nullable
public String getCitizenshipCountry()
        The country of citizenship.
        Returns:
        citizenshipCountry

      • setCitizenshipCountry

        public void setCitizenshipCountry​(String citizenshipCountry)

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

      • getResidenceZip

        @Nullable
public String getResidenceZip()
        The ZIP code of the residence.
        Returns:
        residenceZip

      • setResidenceZip

        public void setResidenceZip​(String residenceZip)

      • getResidenceCountry

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

      • setResidenceCountry

        public void setResidenceCountry​(String residenceCountry)

      • getResidenceIsMailing

        @Nullable
public Boolean getResidenceIsMailing()
        Indicates whether the residence address is the mailing address.
        Returns:
        residenceIsMailing

      • setResidenceIsMailing

        public void setResidenceIsMailing​(Boolean residenceIsMailing)

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

      • getMailingZip

        @Nullable
public String getMailingZip()
        The ZIP code of the mailing address.
        Returns:
        mailingZip

      • setMailingZip

        public void setMailingZip​(String mailingZip)

      • getMailingCountry

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

      • setMailingCountry

        public void setMailingCountry​(String mailingCountry)

      • getTin

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

      • setTin

        public void setTin​(String tin)

      • getForeignTinNotRequired

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

      • setForeignTinNotRequired

        public void setForeignTinNotRequired​(Boolean foreignTinNotRequired)

      • getForeignTin

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

      • setForeignTin

        public void setForeignTin​(String foreignTin)

      • getReferenceNumber

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

      • setReferenceNumber

        public void setReferenceNumber​(String referenceNumber)

      • getBirthday

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

      • setBirthday

        public void setBirthday​(LocalDate birthday)

      • getTreatyCountry

        @Nullable
public String getTreatyCountry()
        The country for which the treaty applies.
        Returns:
        treatyCountry

      • setTreatyCountry

        public void setTreatyCountry​(String treatyCountry)

      • getTreatyArticle

        @Nullable
public String getTreatyArticle()
        The specific article of the treaty being claimed.
        Returns:
        treatyArticle

      • setTreatyArticle

        public void setTreatyArticle​(String treatyArticle)

      • getTreatyReasons

        @Nullable
public String getTreatyReasons()
        The reasons for claiming treaty benefits.
        Returns:
        treatyReasons

      • setTreatyReasons

        public void setTreatyReasons​(String treatyReasons)

      • getWithholdingRate

        @Nullable
public String getWithholdingRate()
        The withholding rate applied as per the treaty.
        Returns:
        withholdingRate

      • setWithholdingRate

        public void setWithholdingRate​(String withholdingRate)

      • getIncomeType

        @Nullable
public String getIncomeType()
        The type of income covered by the treaty.
        Returns:
        incomeType

      • setIncomeType

        public void setIncomeType​(String incomeType)

      • getSignerName

        @Nullable
public String getSignerName()
        The name of the signer of the form.
        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)

      • getSignature

        @Nullable
public String getSignature()
        The signature of the form.
        Returns:
        signature

      • setSignature

        public void setSignature​(String signature)

      • getCompanyId

        @Nonnull
public String getCompanyId()
        The ID of the associated company.
        Returns:
        companyId

      • setCompanyId

        public void setCompanyId​(String companyId)

      • getReferenceId

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

      • setReferenceId

        public void setReferenceId​(String referenceId)

      • getEmail

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

      • setEmail

        public void setEmail​(String email)

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

      • fromJson

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

      • toJson

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