Class W4FormResponse

    • Constructor Detail

      • W4FormResponse

        public W4FormResponse()
    • Method Detail

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

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

        public void setAddress​(String address)
      • getCity

        @Nullable
        public String getCity()
        The city of residence of the employee.
        Returns:
        city
      • setCity

        public void setCity​(String city)
      • getState

        @Nullable
        public String getState()
        The state of residence of the employee.
        Returns:
        state
      • setState

        public void setState​(String state)
      • getZip

        @Nullable
        public String getZip()
        The ZIP code of residence of the employee.
        Returns:
        zip
      • setZip

        public void setZip​(String zip)
      • getMaritalStatus

        @Nullable
        public String getMaritalStatus()
        The marital status of the employee.
        Returns:
        maritalStatus
      • setMaritalStatus

        public void setMaritalStatus​(String maritalStatus)
      • getLastNameDiffers

        @Nullable
        public Boolean getLastNameDiffers()
        Indicates whether the last name differs from prior records.
        Returns:
        lastNameDiffers
      • setLastNameDiffers

        public void setLastNameDiffers​(Boolean lastNameDiffers)
      • getNumAllowances

        @Nullable
        public Integer getNumAllowances()
        The number of allowances claimed by the employee.
        Returns:
        numAllowances
      • setNumAllowances

        public void setNumAllowances​(Integer numAllowances)
      • getOtherDependents

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

        public void setOtherDependents​(Integer otherDependents)
      • getNonJobIncome

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

        public void setNonJobIncome​(Float nonJobIncome)
      • getDeductions

        @Nullable
        public Float getDeductions()
        The amount of deductions claimed.
        Returns:
        deductions
      • setDeductions

        public void setDeductions​(Float deductions)
      • getAdditionalWithheld

        @Nullable
        public Float getAdditionalWithheld()
        The additional amount withheld.
        Returns:
        additionalWithheld
      • setAdditionalWithheld

        public void setAdditionalWithheld​(Float additionalWithheld)
      • getExemptFromWithholding

        @Nullable
        public Boolean getExemptFromWithholding()
        Indicates whether the employee is exempt from withholding.
        Returns:
        exemptFromWithholding
      • setExemptFromWithholding

        public void setExemptFromWithholding​(Boolean exemptFromWithholding)
      • getOfficeCode

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

        public void setOfficeCode​(String officeCode)
      • 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 W4FormResponse
      • fromJson

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

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