Class W4FormRequest


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

      • W4FormRequest

        public W4FormRequest()
    • 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)
      • additionalWithheld

        public W4FormRequest additionalWithheld​(Float additionalWithheld)
      • getAdditionalWithheld

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

        public void setAdditionalWithheld​(Float additionalWithheld)
      • exemptFromWithholding

        public W4FormRequest exemptFromWithholding​(Boolean exemptFromWithholding)
      • 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)
      • 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 W4FormRequest
      • fromJson

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

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