Class W9FormResponse

    • Constructor Detail

      • W9FormResponse

        public W9FormResponse()
    • 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)
      • getBusinessName

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

        public void setBusinessName​(String businessName)
      • businessClassification

        public W9FormResponse businessClassification​(String businessClassification)
      • getBusinessClassification

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

        public void setBusinessClassification​(String businessClassification)
      • getBusinessOther

        @Nullable
        public String getBusinessOther()
        The classification description when \"businessClassification\" is \"Other\".
        Returns:
        businessOther
      • setBusinessOther

        public void setBusinessOther​(String businessOther)
      • foreignPartnerOwnerOrBeneficiary

        public W9FormResponse 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)
      • getExemptPayeeCode

        @Nullable
        public String getExemptPayeeCode()
        The exempt payee code.
        Returns:
        exemptPayeeCode
      • setExemptPayeeCode

        public void setExemptPayeeCode​(String exemptPayeeCode)
      • getExemptFatcaCode

        @Nullable
        public String getExemptFatcaCode()
        The exemption from FATCA reporting code.
        Returns:
        exemptFatcaCode
      • setExemptFatcaCode

        public void setExemptFatcaCode​(String exemptFatcaCode)
      • foreignCountryIndicator

        public W9FormResponse foreignCountryIndicator​(Boolean foreignCountryIndicator)
      • getForeignCountryIndicator

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

        public void setForeignCountryIndicator​(Boolean foreignCountryIndicator)
      • getAddress

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

        public void setAddress​(String address)
      • getForeignAddress

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

        public void setForeignAddress​(String foreignAddress)
      • 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)
      • getAccountNumber

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

        public void setAccountNumber​(String accountNumber)
      • getTinType

        @Nullable
        public String getTinType()
        The type of TIN provided.
        Returns:
        tinType
      • setTinType

        public void setTinType​(String tinType)
      • getTin

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

        public void setTin​(String tin)
      • getBackupWithholding

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

        public void setBackupWithholding​(Boolean backupWithholding)
      • getIs1099able

        @Nullable
        public Boolean getIs1099able()
        Indicates whether the individual or entity should be issued a 1099 form.
        Returns:
        is1099able
      • setIs1099able

        public void setIs1099able​(Boolean is1099able)
      • 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 W9FormResponse
      • fromJson

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

        public String toJson()
        Convert an instance of W9FormResponse to an JSON string
        Overrides:
        toJson in class W9FormBaseResponse
        Returns:
        JSON string