Class Form1099R


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               comments="Generator version: 7.7.0")
    public class Form1099R
    extends Object
    Form 1099-R: Distributions From Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc. *At least one of the following amounts must be provided:* Gross distribution, Taxable amount, Capital gain, Employee contributions/Designated Roth contributions or insurance premiums, Net unrealized appreciation in employer's securities, Other amount, Total employee contributions, Traditional IRA/SEP/SIMPLE or Roth conversion amount, or Amount allocable to IRR within 5 years
    • Method Detail

      • grossDistribution

        public Form1099R grossDistribution​(Double grossDistribution)
      • getGrossDistribution

        @Nullable
        public Double getGrossDistribution()
        Gross distribution
        Returns:
        grossDistribution
      • setGrossDistribution

        public void setGrossDistribution​(Double grossDistribution)
      • getTaxableAmount

        @Nullable
        public Double getTaxableAmount()
        Taxable amount
        Returns:
        taxableAmount
      • setTaxableAmount

        public void setTaxableAmount​(Double taxableAmount)
      • taxableAmountNotDetermined

        public Form1099R taxableAmountNotDetermined​(Boolean taxableAmountNotDetermined)
      • getTaxableAmountNotDetermined

        @Nullable
        public Boolean getTaxableAmountNotDetermined()
        Taxable amount not determined
        Returns:
        taxableAmountNotDetermined
      • setTaxableAmountNotDetermined

        public void setTaxableAmountNotDetermined​(Boolean taxableAmountNotDetermined)
      • totalDistributionDetermined

        public Form1099R totalDistributionDetermined​(Boolean totalDistributionDetermined)
      • getTotalDistributionDetermined

        @Nullable
        public Boolean getTotalDistributionDetermined()
        Total distribution
        Returns:
        totalDistributionDetermined
      • setTotalDistributionDetermined

        public void setTotalDistributionDetermined​(Boolean totalDistributionDetermined)
      • getCapitalGain

        @Nullable
        public Double getCapitalGain()
        Capital gain (included in Box 2a)
        Returns:
        capitalGain
      • setCapitalGain

        public void setCapitalGain​(Double capitalGain)
      • federalIncomeTaxWithheld

        public Form1099R federalIncomeTaxWithheld​(Double federalIncomeTaxWithheld)
      • getFederalIncomeTaxWithheld

        @Nullable
        public Double getFederalIncomeTaxWithheld()
        Federal income tax withheld
        Returns:
        federalIncomeTaxWithheld
      • setFederalIncomeTaxWithheld

        public void setFederalIncomeTaxWithheld​(Double federalIncomeTaxWithheld)
      • employeeContributionsOrDesignatedRothOrInsurancePremiums

        public Form1099R employeeContributionsOrDesignatedRothOrInsurancePremiums​(Double employeeContributionsOrDesignatedRothOrInsurancePremiums)
      • getEmployeeContributionsOrDesignatedRothOrInsurancePremiums

        @Nullable
        public Double getEmployeeContributionsOrDesignatedRothOrInsurancePremiums()
        Employee contributions/Designated Roth contributions or insurance premiums
        Returns:
        employeeContributionsOrDesignatedRothOrInsurancePremiums
      • setEmployeeContributionsOrDesignatedRothOrInsurancePremiums

        public void setEmployeeContributionsOrDesignatedRothOrInsurancePremiums​(Double employeeContributionsOrDesignatedRothOrInsurancePremiums)
      • netUnrealizedAppreciationInEmployerSecurities

        public Form1099R netUnrealizedAppreciationInEmployerSecurities​(Double netUnrealizedAppreciationInEmployerSecurities)
      • getNetUnrealizedAppreciationInEmployerSecurities

        @Nullable
        public Double getNetUnrealizedAppreciationInEmployerSecurities()
        Net unrealized appreciation in employer's securities
        Returns:
        netUnrealizedAppreciationInEmployerSecurities
      • setNetUnrealizedAppreciationInEmployerSecurities

        public void setNetUnrealizedAppreciationInEmployerSecurities​(Double netUnrealizedAppreciationInEmployerSecurities)
      • getDistributionCode

        @Nullable
        public Form1099R.DistributionCodeEnum getDistributionCode()
        Distribution code. Available values: - 1: Early distribution, no known exception (in most cases, under age 59½) - 2: Early distribution, exception applies (under age 59½) - 3: Disability - 4: Death - 5: Prohibited transaction - 6: Section 1035 exchange (a tax-free exchange of life insurance, annuity, qualified long-term care insurance, or endowment contracts) - 7: Normal distribution - 8: Excess contributions plus earnings/excess deferrals (and/or earnings) taxable in payment year - 9: Cost of current life insurance protection (premiums paid by a trustee or custodian for current insurance protection) - A: May be eligible for 10-year tax option - B: Designated Roth account distribution - C: Reportable Death Benefits Under Section 6050Y(c) - D: Annuity payments from nonqualified annuity payments and distributions from life insurance contracts that may be subject to tax under section 1411 - E: Distribution under Employee Plans Compliance Resolution System (EPCRS) - F: Charitable gift annuity - G: Direct rollover and rollover contribution - H: Direct rollover of distribution from a designated Roth account to a Roth IRA - J: Early distribution from a Roth IRA (This code may be used with a Code 8 or P) - K: Distribution of IRA Assets Not Having A Readily Available FMV - L: Loans treated as deemed distributions under section 72(p) - M: Qualified Plan Loan Offsets - N: Recharacterized IRA contribution made for year following payment year - P: Excess contributions plus earnings/excess deferrals taxable for year prior to payment year - Q: Qualified distribution from a Roth IRA (Distribution from a Roth IRA when the 5-year holding period has been met, and the recipient has reached 59½, has died, or is disabled) - R: Recharacterized IRA contribution made for year prior to payment year - S: Early distribution from a SIMPLE IRA in first 2 years no known exceptions - T: Roth IRA distribution exception applies because participant has reached 59½, died or is disabled, but it is unknown if the 5-year period has been met - U: Distribution from ESOP under Section 404(k) - W: Charges or payments for purchasing qualified long-term care insurance contracts under combined arrangements
        Returns:
        distributionCode
      • getSecondDistributionCode

        @Nullable
        public Form1099R.SecondDistributionCodeEnum getSecondDistributionCode()
        Second distribution code. Must be a valid combination with the first distribution code. See DistributionCode property documentation for code descriptions. Valid combinations based on first distribution code: - 1: _, 8, B, D, K, L, M, P - 2: _, 8, B, D, K, L, M, P - 3: _, D - 4: _, 8, A, B, D, G, H, K, L, M, P - 5: _ - 6: _, W - 7: _, A, B, D, K, L, M - 8: _, 1, 2, 4, B, J, K - 9: _ - A: 4, 7 - B: _, 1, 2, 4, 7, 8, G, L, M, P, U - C: _, D - D: 1, 2, 3, 4, 7, C - E: _ - F: _ - G: _, 4, B, K - H: _, 4 - J: _, 8, P - K: 1, 2, 4, 7, 8, G - L: _, 1, 2, 4, 7, B - M: _, 1, 2, 4, 7, B - N: _ - P: _, 1, 2, 4, B, J - Q: _ - R: _ - S: _ - T: _ - U: _, B - W: _, 6 (_ indicates no second distribution code) (format: firstDistributionCode: availableSecondDistributionCodes)
        Returns:
        secondDistributionCode
      • getIraSepSimple

        @Nullable
        public Boolean getIraSepSimple()
        IRA/SEP/SIMPLE
        Returns:
        iraSepSimple
      • setIraSepSimple

        public void setIraSepSimple​(Boolean iraSepSimple)
      • traditionalIraSepSimpleOrRothConversionAmount

        public Form1099R traditionalIraSepSimpleOrRothConversionAmount​(Double traditionalIraSepSimpleOrRothConversionAmount)
      • getTraditionalIraSepSimpleOrRothConversionAmount

        @Nullable
        public Double getTraditionalIraSepSimpleOrRothConversionAmount()
        Traditional IRA/SEP/SIMPLE or Roth conversion amount
        Returns:
        traditionalIraSepSimpleOrRothConversionAmount
      • setTraditionalIraSepSimpleOrRothConversionAmount

        public void setTraditionalIraSepSimpleOrRothConversionAmount​(Double traditionalIraSepSimpleOrRothConversionAmount)
      • getOtherAmount

        @Nullable
        public Double getOtherAmount()
        Other amount
        Returns:
        otherAmount
      • setOtherAmount

        public void setOtherAmount​(Double otherAmount)
      • otherPercentage

        public Form1099R otherPercentage​(String otherPercentage)
      • getOtherPercentage

        @Nullable
        public String getOtherPercentage()
        Other percentage
        Returns:
        otherPercentage
      • setOtherPercentage

        public void setOtherPercentage​(String otherPercentage)
      • totalDistributionPercentage

        public Form1099R totalDistributionPercentage​(String totalDistributionPercentage)
      • getTotalDistributionPercentage

        @Nullable
        public String getTotalDistributionPercentage()
        Total distribution percentage
        Returns:
        totalDistributionPercentage
      • setTotalDistributionPercentage

        public void setTotalDistributionPercentage​(String totalDistributionPercentage)
      • totalEmployeeContributions

        public Form1099R totalEmployeeContributions​(Double totalEmployeeContributions)
      • getTotalEmployeeContributions

        @Nullable
        public Double getTotalEmployeeContributions()
        Total employee contributions
        Returns:
        totalEmployeeContributions
      • setTotalEmployeeContributions

        public void setTotalEmployeeContributions​(Double totalEmployeeContributions)
      • amountAllocableToIrrWithin5Years

        public Form1099R amountAllocableToIrrWithin5Years​(Double amountAllocableToIrrWithin5Years)
      • getAmountAllocableToIrrWithin5Years

        @Nullable
        public Double getAmountAllocableToIrrWithin5Years()
        Amount allocable to IRR within 5 years
        Returns:
        amountAllocableToIrrWithin5Years
      • setAmountAllocableToIrrWithin5Years

        public void setAmountAllocableToIrrWithin5Years​(Double amountAllocableToIrrWithin5Years)
      • firstYearOfDesignatedRothContribution

        public Form1099R firstYearOfDesignatedRothContribution​(String firstYearOfDesignatedRothContribution)
      • getFirstYearOfDesignatedRothContribution

        @Nullable
        public String getFirstYearOfDesignatedRothContribution()
        First year of designated Roth contribution
        Returns:
        firstYearOfDesignatedRothContribution
      • setFirstYearOfDesignatedRothContribution

        public void setFirstYearOfDesignatedRothContribution​(String firstYearOfDesignatedRothContribution)
      • getDateOfPayment

        @Nullable
        public LocalDate getDateOfPayment()
        Date of payment
        Returns:
        dateOfPayment
      • setDateOfPayment

        public void setDateOfPayment​(LocalDate dateOfPayment)
      • fatcaFilingRequirement

        public Form1099R fatcaFilingRequirement​(Boolean fatcaFilingRequirement)
      • getFatcaFilingRequirement

        @Nullable
        public Boolean getFatcaFilingRequirement()
        FATCA filing requirement.
        Returns:
        fatcaFilingRequirement
      • setFatcaFilingRequirement

        public void setFatcaFilingRequirement​(Boolean fatcaFilingRequirement)
      • 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 Form1099R issuerReferenceId​(String issuerReferenceId)
      • getIssuerReferenceId

        @Nullable
        public String getIssuerReferenceId()
        Issuer Reference ID - only required when creating forms via $bulk-upsert
        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 via $bulk-upsert
        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)
      • getTinType

        @Nullable
        public Form1099R.TinTypeEnum getTinType()
        Tax Identification Number (TIN) type. Available values: - EIN: Employer Identification Number - SSN: Social Security Number - ITIN: Individual Taxpayer Identification Number - ATIN: Adoption Taxpayer Identification Number
        Returns:
        tinType
      • recipientSecondName

        public Form1099R 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. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.
        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. Must be on or after federalEfileDate. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.
        Returns:
        stateEfileDate
      • setStateEfileDate

        public void setStateEfileDate​(LocalDate stateEfileDate)
      • recipientEdeliveryDate

        public Form1099R recipientEdeliveryDate​(LocalDate recipientEdeliveryDate)
      • getRecipientEdeliveryDate

        @Nullable
        public LocalDate getRecipientEdeliveryDate()
        Date when recipient e-delivery should be scheduled. If set between current date and beginning of blackout period, scheduled to that date. If in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. Set to null to leave unscheduled.
        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 Form1099R 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 Form1099R secondTinNotice​(Boolean secondTinNotice)
      • getSecondTinNotice

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

        public void setSecondTinNotice​(Boolean secondTinNotice)
      • getFederalEfileStatus

        @Nullable
        public Form1099StatusDetail getFederalEfileStatus()
        Federal e-file status. Available values: - unscheduled: Form has not been scheduled for federal e-filing - scheduled: Form is scheduled for federal e-filing - airlock: Form is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - sent: Form has been sent to the IRS - accepted: Form was accepted by the IRS - corrected_scheduled: Correction is scheduled to be sent - corrected_airlock: Correction is in process of being uploaded to the IRS (forms exist in this state for a very short period and cannot be updated while in this state) - corrected: A correction has been sent to the IRS - corrected_accepted: Correction was accepted by the IRS - rejected: Form was rejected by the IRS - corrected_rejected: Correction was rejected by the IRS - held: Form is held and will not be submitted to IRS (used for certain forms submitted only to states)
        Returns:
        federalEfileStatus
      • getStateEfileStatus

        @Nullable
        public List<StateEfileStatusDetail> getStateEfileStatus()
        State e-file status. Available values: - unscheduled: Form has not been scheduled for state e-filing - scheduled: Form is scheduled for state e-filing - airlocked: Form is in process of being uploaded to the state - sent: Form has been sent to the state - rejected: Form was rejected by the state - accepted: Form was accepted by the state - corrected_scheduled: Correction is scheduled to be sent - corrected_airlocked: Correction is in process of being uploaded to the state - corrected_sent: Correction has been sent to the state - corrected_rejected: Correction was rejected by the state - corrected_accepted: Correction was accepted by the state
        Returns:
        stateEfileStatus
      • getPostalMailStatus

        @Nullable
        public Form1099StatusDetail getPostalMailStatus()
        Postal mail to recipient status. Available values: - unscheduled: Postal mail has not been scheduled - pending: Postal mail is pending to be sent - sent: Postal mail has been sent - delivered: Postal mail has been delivered
        Returns:
        postalMailStatus
      • getTinMatchStatus

        @Nullable
        public Form1099StatusDetail getTinMatchStatus()
        TIN Match status. Available values: - none: TIN matching has not been performed - pending: TIN matching request is pending - matched: Name/TIN combination matches IRS records - unknown: TIN is missing, invalid, or request contains errors - rejected: Name/TIN combination does not match IRS records or TIN not currently issued
        Returns:
        tinMatchStatus
      • getAddressVerificationStatus

        @Nullable
        public Form1099StatusDetail getAddressVerificationStatus()
        Address verification status. Available values: - unknown: Address verification has not been checked - pending: Address verification is in progress - failed: Address verification failed - incomplete: Address verification is incomplete - unchanged: User declined address changes - verified: Address has been verified and accepted
        Returns:
        addressVerificationStatus
      • geteDeliveryStatus

        @Nullable
        public Form1099StatusDetail geteDeliveryStatus()
        EDelivery status. Available values: - unscheduled: E-delivery has not been scheduled - scheduled: E-delivery is scheduled to be sent - sent: E-delivery has been sent to recipient - bounced: E-delivery bounced back (invalid email) - refused: E-delivery was refused by recipient - bad_verify: E-delivery failed verification - accepted: E-delivery was accepted by recipient - bad_verify_limit: E-delivery failed verification limit reached - second_delivery: Second e-delivery attempt - undelivered: E-delivery is undelivered (temporary state allowing resend)
        Returns:
        eDeliveryStatus
      • 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 Form1099R
      • fromJson

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

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