Package Avalara.SDK.model.A1099.V2

Class Form1042S

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class Form1042S
extends Object
    Form 1042-S: Foreign Person's U.S. Source Income Subject to Withholding

    • Method Detail

      • getUniqueFormId

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

      • setUniqueFormId

        public void setUniqueFormId​(String uniqueFormId)

      • recipientDateOfBirth

        public Form1042S recipientDateOfBirth​(LocalDate recipientDateOfBirth)

      • getRecipientDateOfBirth

        @Nullable
public LocalDate getRecipientDateOfBirth()
        Recipient's date of birth
        Returns:
        recipientDateOfBirth

      • setRecipientDateOfBirth

        public void setRecipientDateOfBirth​(LocalDate recipientDateOfBirth)

      • getRecipientGiin

        @Nullable
public String getRecipientGiin()
        Recipient's Global Intermediary Identification Number (GIIN). A valid GIIN looks like 'XXXXXX.XXXXX.XX.XXX'.
        Returns:
        recipientGiin

      • setRecipientGiin

        public void setRecipientGiin​(String recipientGiin)

      • recipientForeignTin

        public Form1042S recipientForeignTin​(String recipientForeignTin)

      • getRecipientForeignTin

        @Nullable
public String getRecipientForeignTin()
        Recipient's foreign TIN. Required if email is specified, must fill either this or Chap3StatusCode.
        Returns:
        recipientForeignTin

      • setRecipientForeignTin

        public void setRecipientForeignTin​(String recipientForeignTin)

      • getLobCode

        @Nullable
public Form1042S.LobCodeEnum getLobCode()
        Limitation on Benefits (LOB) code for tax treaty purposes. Available values: - 01: Individual (Deprecated - valid only for tax years prior to 2019) - 02: Government - contracting state/political subdivision/local authority - 03: Tax exempt pension trust/Pension fund - 04: Tax exempt/Charitable organization - 05: Publicly-traded corporation - 06: Subsidiary of publicly-traded corporation - 07: Company that meets the ownership and base erosion test - 08: Company that meets the derivative benefits test - 09: Company with an item of income that meets the active trade or business test - 10: Discretionary determination - 11: Other - 12: No LOB article in treaty
        Returns:
        lobCode

      • getIncomeCode

        @Nullable
public Form1042S.IncomeCodeEnum getIncomeCode()
        Income code. Available values: Interest: - 01: Interest paid by US obligors - general - 02: Interest paid on real property mortgages - 03: Interest paid to controlling foreign corporations - 04: Interest paid by foreign corporations - 05: Interest on tax-free covenant bonds - 22: Interest paid on deposit with a foreign branch of a domestic corporation or partnership - 29: Deposit interest - 30: Original issue discount (OID) - 31: Short-term OID - 33: Substitute payment - interest - 51: Interest paid on certain actively traded or publicly offered securities(1) - 54: Substitute payments - interest from certain actively traded or publicly offered securities(1) Dividend: - 06: Dividends paid by U.S. corporations - general - 07: Dividends qualifying for direct dividend rate - 08: Dividends paid by foreign corporations - 34: Substitute payment - dividends - 40: Other dividend equivalents under IRC section 871(m) (formerly 871(l)) - 52: Dividends paid on certain actively traded or publicly offered securities(1) - 53: Substitute payments - dividends from certain actively traded or publicly offered securities(1) - 56: Dividend equivalents under IRC section 871(m) as a result of applying the combined transaction rules Other: - 09: Capital gains - 10: Industrial royalties - 11: Motion picture or television copyright royalties - 12: Other royalties (for example, copyright, software, broadcasting, endorsement payments) - 13: Royalties paid on certain publicly offered securities(1) - 14: Real property income and natural resources royalties - 15: Pensions, annuities, alimony, and/or insurance premiums - 16: Scholarship or fellowship grants - 17: Compensation for independent personal services(2) - 18: Compensation for dependent personal services(2) - 19: Compensation for teaching(2) - 20: Compensation during studying and training(2) - 23: Other income - 24: Qualified investment entity (QIE) distributions of capital gains - 25: Trust distributions subject to IRC section 1445 - 26: Unsevered growing crops and timber distributions by a trust subject to IRC section 1445 - 27: Publicly traded partnership distributions subject to IRC section 1446 - 28: Gambling winnings(3) - 32: Notional principal contract income(4) - 35: Substitute payment - other - 36: Capital gains distributions - 37: Return of capital - 38: Eligible deferred compensation items subject to IRC section 877A(d)(1) - 39: Distributions from a nongrantor trust subject to IRC section 877A(f)(1) - 41: Guarantee of indebtedness - 42: Earnings as an artist or athlete - no central withholding agreement(5) - 43: Earnings as an artist or athlete - central withholding agreement(5) - 44: Specified Federal procurement payments - 50: Income previously reported under escrow procedure(6) - 55: Taxable death benefits on life insurance contracts - 57: Amount realized under IRC section 1446(f) - 58: Publicly traded partnership distributions-undetermined
        Returns:
        incomeCode

      • getGrossIncome

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

      • setGrossIncome

        public void setGrossIncome​(Double grossIncome)

      • taxCountryCode

        public Form1042S taxCountryCode​(String taxCountryCode)

      • getTaxCountryCode

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

      • setTaxCountryCode

        public void setTaxCountryCode​(String taxCountryCode)

      • getExemptionCodeChap3

        @Nullable
public Form1042S.ExemptionCodeChap3Enum getExemptionCodeChap3()
        Exemption code (Chapter 3). Required if WithholdingIndicator is 3 (Chapter 3). Required when using TaxRateChap3. Available values: - Empty: Tax rate is due to backup withholding - 00: Not exempt - 01: Effectively connected income - 02: Exempt under IRC (other than portfolio interest) - 03: Income is not from US sources - 04: Exempt under tax treaty - 05: Portfolio interest exempt under IRC - 06: QI that assumes primary withholding responsibility - 07: WFP or WFT - 08: U.S. branch treated as U.S. Person - 09: Territory FI treated as U.S. Person - 10: QI represents that income is exempt - 11: QSL that assumes primary withholding responsibility - 12: Payee subjected to chapter 4 withholding - 22: QDD that assumes primary withholding responsibility - 23: Exempt under section 897(l) - 24: Exempt under section 892
        Returns:
        exemptionCodeChap3

      • getExemptionCodeChap4

        @Nullable
public Form1042S.ExemptionCodeChap4Enum getExemptionCodeChap4()
        Exemption code (Chapter 4). Required if WithholdingIndicator is 4 (Chapter 4). Available values: - 00: Not exempt - 13: Grandfathered payment - 14: Effectively connected income - 15: Payee not subject to chapter 4 withholding - 16: Excluded nonfinancial payment - 17: Foreign Entity that assumes primary withholding responsibility - 18: U.S. Payees - of participating FFI or registered deemed - compliant FFI - 19: Exempt from withholding under IGA(6) - 20: Dormant account(7) - 21: Other - payment not subject to chapter 4 withholding
        Returns:
        exemptionCodeChap4

      • getTaxRateChap3

        @Nullable
public Form1042S.TaxRateChap3Enum getTaxRateChap3()
        Tax rate (Chapter 3) - Required if WithholdingIndicator is 3 (Chapter 3). Available values: - 00.00: 0.00% - 02.00: 2.00% - 04.00: 4.00% - 04.90: 4.90% - 04.95: 4.95% - 05.00: 5.00% - 07.00: 7.00% - 08.00: 8.00% - 10.00: 10.00% - 12.00: 12.00% - 12.50: 12.50% - 14.00: 14.00% - 15.00: 15.00% - 17.50: 17.50% - 20.00: 20.00% - 21.00: 21.00% - 24.00: 24.00% - 25.00: 25.00% - 27.50: 27.50% - 28.00: 28.00% - 30.00: 30.00% - 37.00: 37.00%
        Returns:
        taxRateChap3

      • withholdingAllowance

        public Form1042S withholdingAllowance​(Double withholdingAllowance)

      • getWithholdingAllowance

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

      • setWithholdingAllowance

        public void setWithholdingAllowance​(Double withholdingAllowance)

      • federalTaxWithheld

        public Form1042S federalTaxWithheld​(Double federalTaxWithheld)

      • getFederalTaxWithheld

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

      • setFederalTaxWithheld

        public void setFederalTaxWithheld​(Double federalTaxWithheld)

      • taxNotDepositedIndicator

        public Form1042S taxNotDepositedIndicator​(Boolean taxNotDepositedIndicator)

      • getTaxNotDepositedIndicator

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

      • setTaxNotDepositedIndicator

        public void setTaxNotDepositedIndicator​(Boolean taxNotDepositedIndicator)

      • academicIndicator

        public Form1042S academicIndicator​(Boolean academicIndicator)

      • getAcademicIndicator

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

      • setAcademicIndicator

        public void setAcademicIndicator​(Boolean academicIndicator)

      • taxWithheldOtherAgents

        public Form1042S taxWithheldOtherAgents​(Double taxWithheldOtherAgents)

      • 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 Form1042S.Chap3StatusCodeEnum getChap3StatusCode()
        Chapter 3 status code - Required if WithholdingIndicator is 3 (Chapter 3) Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary
        Returns:
        chap3StatusCode

      • getChap4StatusCode

        @Nullable
public Form1042S.Chap4StatusCodeEnum getChap4StatusCode()
        Chapter 4 status code. Required if WithholdingIndicator is 4 (Chapter 4). Required if email is specified, must fill either this or RecipientForeignTin. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI
        Returns:
        chap4StatusCode

      • getPrimaryWithholdingAgent

        @Nullable
public PrimaryWithholdingAgent getPrimaryWithholdingAgent()
        Primary withholding agent information
        Returns:
        primaryWithholdingAgent

      • setPrimaryWithholdingAgent

        public void setPrimaryWithholdingAgent​(PrimaryWithholdingAgent primaryWithholdingAgent)

      • getIntermediaryOrFlowThrough

        @Nullable
public IntermediaryOrFlowThrough getIntermediaryOrFlowThrough()
        Intermediary or flow-through entity information
        Returns:
        intermediaryOrFlowThrough

      • setIntermediaryOrFlowThrough

        public void setIntermediaryOrFlowThrough​(IntermediaryOrFlowThrough intermediaryOrFlowThrough)

      • getId

        @Nullable
public String getId()
        Form ID. Unique identifier set when the record is created.
        Returns:
        id

      • getIssuerId

        @Nullable
public String getIssuerId()
        Issuer ID - only required when creating forms
        Returns:
        issuerId

      • setIssuerId

        public void setIssuerId​(String issuerId)

      • issuerReferenceId

        public Form1042S issuerReferenceId​(String issuerReferenceId)

      • getIssuerReferenceId

        @Nullable
public String getIssuerReferenceId()
        Issuer Reference ID - only required when creating forms
        Returns:
        issuerReferenceId

      • setIssuerReferenceId

        public void setIssuerReferenceId​(String issuerReferenceId)

      • getIssuerTin

        @Nullable
public String getIssuerTin()
        Issuer TIN - readonly
        Returns:
        issuerTin

      • setIssuerTin

        public void setIssuerTin​(String issuerTin)

      • getTaxYear

        @Nullable
public Integer getTaxYear()
        Tax Year - only required when creating forms
        Returns:
        taxYear

      • setTaxYear

        public void setTaxYear​(Integer taxYear)

      • getReferenceId

        @Nullable
public String getReferenceId()
        Internal reference ID. Never shown to any agency or recipient.
        Returns:
        referenceId

      • setReferenceId

        public void setReferenceId​(String referenceId)

      • getTin

        @Nullable
public String getTin()
        Recipient's Federal Tax Identification Number (TIN).
        Returns:
        tin

      • setTin

        public void setTin​(String tin)

      • getRecipientName

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

      • setRecipientName

        public void setRecipientName​(String recipientName)

      • recipientSecondName

        public Form1042S recipientSecondName​(String recipientSecondName)

      • getRecipientSecondName

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

      • setRecipientSecondName

        public void setRecipientSecondName​(String recipientSecondName)

      • getAddress

        @Nullable
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()
        Two-letter US state or Canadian province code (required for US/CA addresses).
        Returns:
        state

      • setState

        public void setState​(String state)

      • setZip

        public void setZip​(String zip)

      • getEmail

        @Nullable
public String getEmail()
        Recipient's Contact 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()
        Province or region for non-US/CA addresses.
        Returns:
        nonUsProvince

      • setNonUsProvince

        public void setNonUsProvince​(String nonUsProvince)

      • getCountryCode

        @Nullable
public String getCountryCode()
        Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes.
        Returns:
        countryCode

      • setCountryCode

        public void setCountryCode​(String countryCode)

      • getFederalEfileDate

        @Nullable
public LocalDate getFederalEfileDate()
        Date when federal e-filing should be scheduled for this form
        Returns:
        federalEfileDate

      • setFederalEfileDate

        public void setFederalEfileDate​(LocalDate federalEfileDate)

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

      • getStateEfileDate

        @Nullable
public LocalDate getStateEfileDate()
        Date when state e-filing should be scheduled for this form
        Returns:
        stateEfileDate

      • setStateEfileDate

        public void setStateEfileDate​(LocalDate stateEfileDate)

      • recipientEdeliveryDate

        public Form1042S recipientEdeliveryDate​(LocalDate recipientEdeliveryDate)

      • getRecipientEdeliveryDate

        @Nullable
public LocalDate getRecipientEdeliveryDate()
        Date when recipient e-delivery should be scheduled for this form
        Returns:
        recipientEdeliveryDate

      • setRecipientEdeliveryDate

        public void setRecipientEdeliveryDate​(LocalDate recipientEdeliveryDate)

      • 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()
        No TIN indicator
        Returns:
        noTin

      • setNoTin

        public void setNoTin​(Boolean noTin)

      • addressVerification

        public Form1042S addressVerification​(Boolean addressVerification)

      • getAddressVerification

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

      • setAddressVerification

        public void setAddressVerification​(Boolean addressVerification)

      • getStateAndLocalWithholding

        @Nullable
public StateAndLocalWithholding getStateAndLocalWithholding()
        State and local withholding information
        Returns:
        stateAndLocalWithholding

      • setStateAndLocalWithholding

        public void setStateAndLocalWithholding​(StateAndLocalWithholding stateAndLocalWithholding)

      • secondTinNotice

        public Form1042S secondTinNotice​(Boolean secondTinNotice)

      • getSecondTinNotice

        @Nullable
public Boolean getSecondTinNotice()
        Second TIN notice
        Returns:
        secondTinNotice

      • setSecondTinNotice

        public void setSecondTinNotice​(Boolean secondTinNotice)

      • getAddressVerificationStatus

        @Nullable
public Form1099StatusDetail getAddressVerificationStatus()
        Address verification status
        Returns:
        addressVerificationStatus

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        Date time when the record was created.
        Returns:
        createdAt

      • getUpdatedAt

        @Nullable
public OffsetDateTime getUpdatedAt()
        Date time when the record was last updated.
        Returns:
        updatedAt

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

      • fromJson

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

      • toJson

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