Class Form1042SRequest


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

      • Form1042SRequest

        public Form1042SRequest()
    • Method Detail

      • getUniqueFormId

        @Nullable
        public String getUniqueFormId()
        Unique form identifier
        Returns:
        uniqueFormId
      • setUniqueFormId

        public void setUniqueFormId​(String uniqueFormId)
      • getRecipientDateOfBirth

        @Nullable
        public OffsetDateTime getRecipientDateOfBirth()
        Recipient's date of birth
        Returns:
        recipientDateOfBirth
      • setRecipientDateOfBirth

        public void setRecipientDateOfBirth​(OffsetDateTime recipientDateOfBirth)
      • getRecipientGiin

        @Nullable
        public String getRecipientGiin()
        Recipient's GIIN (Global Intermediary Identification Number)
        Returns:
        recipientGiin
      • setRecipientGiin

        public void setRecipientGiin​(String recipientGiin)
      • getRecipientForeignTin

        @Nullable
        public String getRecipientForeignTin()
        Recipient's foreign TIN
        Returns:
        recipientForeignTin
      • setRecipientForeignTin

        public void setRecipientForeignTin​(String recipientForeignTin)
      • getLobCode

        @Nullable
        public String getLobCode()
        Limitation on benefits code
        Returns:
        lobCode
      • setLobCode

        public void setLobCode​(String lobCode)
      • getIncomeCode

        @Nullable
        public String getIncomeCode()
        Income code
        Returns:
        incomeCode
      • setIncomeCode

        public void setIncomeCode​(String incomeCode)
      • getGrossIncome

        @Nullable
        public Double getGrossIncome()
        Gross income
        Returns:
        grossIncome
      • setGrossIncome

        public void setGrossIncome​(Double grossIncome)
      • getWithholdingIndicator

        @Nullable
        public String getWithholdingIndicator()
        Withholding indicator
        Returns:
        withholdingIndicator
      • setWithholdingIndicator

        public void setWithholdingIndicator​(String withholdingIndicator)
      • getTaxCountryCode

        @Nullable
        public String getTaxCountryCode()
        Country code
        Returns:
        taxCountryCode
      • setTaxCountryCode

        public void setTaxCountryCode​(String taxCountryCode)
      • getExemptionCodeChap3

        @Nullable
        public String getExemptionCodeChap3()
        Exemption code (Chapter 3)
        Returns:
        exemptionCodeChap3
      • setExemptionCodeChap3

        public void setExemptionCodeChap3​(String exemptionCodeChap3)
      • getExemptionCodeChap4

        @Nullable
        public String getExemptionCodeChap4()
        Exemption code (Chapter 4)
        Returns:
        exemptionCodeChap4
      • setExemptionCodeChap4

        public void setExemptionCodeChap4​(String exemptionCodeChap4)
      • getTaxRateChap3

        @Nullable
        public String getTaxRateChap3()
        Tax rate (Chapter 3)
        Returns:
        taxRateChap3
      • setTaxRateChap3

        public void setTaxRateChap3​(String taxRateChap3)
      • getWithholdingAllowance

        @Nullable
        public Double getWithholdingAllowance()
        Withholding allowance
        Returns:
        withholdingAllowance
      • setWithholdingAllowance

        public void setWithholdingAllowance​(Double withholdingAllowance)
      • getFederalTaxWithheld

        @Nullable
        public Double getFederalTaxWithheld()
        Federal tax withheld
        Returns:
        federalTaxWithheld
      • setFederalTaxWithheld

        public void setFederalTaxWithheld​(Double federalTaxWithheld)
      • taxNotDepositedIndicator

        public Form1042SRequest taxNotDepositedIndicator​(Boolean taxNotDepositedIndicator)
      • getTaxNotDepositedIndicator

        @Nullable
        public Boolean getTaxNotDepositedIndicator()
        Tax not deposited indicator
        Returns:
        taxNotDepositedIndicator
      • setTaxNotDepositedIndicator

        public void setTaxNotDepositedIndicator​(Boolean taxNotDepositedIndicator)
      • getAcademicIndicator

        @Nullable
        public Boolean getAcademicIndicator()
        Academic indicator
        Returns:
        academicIndicator
      • setAcademicIndicator

        public void setAcademicIndicator​(Boolean academicIndicator)
      • getTaxWithheldOtherAgents

        @Nullable
        public Double getTaxWithheldOtherAgents()
        Tax withheld by other agents
        Returns:
        taxWithheldOtherAgents
      • setTaxWithheldOtherAgents

        public void setTaxWithheldOtherAgents​(Double taxWithheldOtherAgents)
      • getAmountRepaid

        @Nullable
        public Double getAmountRepaid()
        Amount repaid to recipient
        Returns:
        amountRepaid
      • setAmountRepaid

        public void setAmountRepaid​(Double amountRepaid)
      • getTaxPaidAgent

        @Nullable
        public Double getTaxPaidAgent()
        Tax paid by withholding agent
        Returns:
        taxPaidAgent
      • setTaxPaidAgent

        public void setTaxPaidAgent​(Double taxPaidAgent)
      • getChap3StatusCode

        @Nullable
        public String getChap3StatusCode()
        Chapter 3 status code
        Returns:
        chap3StatusCode
      • setChap3StatusCode

        public void setChap3StatusCode​(String chap3StatusCode)
      • getChap4StatusCode

        @Nullable
        public String getChap4StatusCode()
        Chapter 4 status code
        Returns:
        chap4StatusCode
      • setChap4StatusCode

        public void setChap4StatusCode​(String chap4StatusCode)
      • getIssuerId

        @Nullable
        public String getIssuerId()
        Issuer ID
        Returns:
        issuerId
      • setIssuerId

        public void setIssuerId​(String issuerId)
      • getReferenceId

        @Nullable
        public String getReferenceId()
        Reference ID
        Returns:
        referenceId
      • setReferenceId

        public void setReferenceId​(String referenceId)
      • getRecipientTin

        @Nullable
        public String getRecipientTin()
        Recipient Tax ID Number
        Returns:
        recipientTin
      • setRecipientTin

        public void setRecipientTin​(String recipientTin)
      • getRecipientName

        @Nullable
        public String getRecipientName()
        Recipient name
        Returns:
        recipientName
      • setRecipientName

        public void setRecipientName​(String recipientName)
      • getRecipientSecondName

        @Nullable
        public String getRecipientSecondName()
        Recipient second name
        Returns:
        recipientSecondName
      • setRecipientSecondName

        public void setRecipientSecondName​(String recipientSecondName)
      • getAddress

        @Nonnull
        public String getAddress()
        Address
        Returns:
        address
      • setAddress

        public void setAddress​(String address)
      • getAddress2

        @Nullable
        public String getAddress2()
        Address line 2
        Returns:
        address2
      • setAddress2

        public void setAddress2​(String address2)
      • setCity

        public void setCity​(String city)
      • getState

        @Nullable
        public String getState()
        US state. Required if CountryCode is \"US\".
        Returns:
        state
      • setState

        public void setState​(String state)
      • setZip

        public void setZip​(String zip)
      • getEmail

        @Nullable
        public String getEmail()
        Recipient email address
        Returns:
        email
      • setEmail

        public void setEmail​(String email)
      • getAccountNumber

        @Nullable
        public String getAccountNumber()
        Account number
        Returns:
        accountNumber
      • setAccountNumber

        public void setAccountNumber​(String accountNumber)
      • getOfficeCode

        @Nullable
        public String getOfficeCode()
        Office code
        Returns:
        officeCode
      • setOfficeCode

        public void setOfficeCode​(String officeCode)
      • getNonUsProvince

        @Nullable
        public String getNonUsProvince()
        Foreign province
        Returns:
        nonUsProvince
      • setNonUsProvince

        public void setNonUsProvince​(String nonUsProvince)
      • getCountryCode

        @Nonnull
        public String getCountryCode()
        Country code, as defined at https://www.irs.gov/e-file-providers/country-codes
        Returns:
        countryCode
      • setCountryCode

        public void setCountryCode​(String countryCode)
      • getFederalEFile

        @Nullable
        public Boolean getFederalEFile()
        Boolean indicating that federal e-filing should be scheduled for this form
        Returns:
        federalEFile
      • setFederalEFile

        public void setFederalEFile​(Boolean federalEFile)
      • getPostalMail

        @Nullable
        public Boolean getPostalMail()
        Boolean indicating that postal mailing to the recipient should be scheduled for this form
        Returns:
        postalMail
      • setPostalMail

        public void setPostalMail​(Boolean postalMail)
      • getStateEFile

        @Nullable
        public Boolean getStateEFile()
        Boolean indicating that state e-filing should be scheduled for this form
        Returns:
        stateEFile
      • setStateEFile

        public void setStateEFile​(Boolean stateEFile)
      • getTinMatch

        @Nullable
        public Boolean getTinMatch()
        Boolean indicating that TIN Matching should be scheduled for this form
        Returns:
        tinMatch
      • setTinMatch

        public void setTinMatch​(Boolean tinMatch)
      • getNoTin

        @Nullable
        public Boolean getNoTin()
        Indicates whether the recipient has no TIN
        Returns:
        noTin
      • setNoTin

        public void setNoTin​(Boolean noTin)
      • getSecondTinNotice

        @Nullable
        public Boolean getSecondTinNotice()
        Second TIN notice in three years
        Returns:
        secondTinNotice
      • setSecondTinNotice

        public void setSecondTinNotice​(Boolean secondTinNotice)
      • getAddressVerification

        @Nullable
        public Boolean getAddressVerification()
        Boolean indicating that address verification should be scheduled for this form
        Returns:
        addressVerification
      • setAddressVerification

        public void setAddressVerification​(Boolean addressVerification)
      • 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 Form1042SRequest
      • fromJson

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

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