Class Form1095B


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               comments="Generator version: 7.7.0")
    public class Form1095B
    extends Object
    Form 1095-B: Health Coverage
    • Method Detail

      • employeeFirstName

        public Form1095B employeeFirstName​(String employeeFirstName)
      • getEmployeeFirstName

        @Nullable
        public String getEmployeeFirstName()
        Employee's first name
        Returns:
        employeeFirstName
      • setEmployeeFirstName

        public void setEmployeeFirstName​(String employeeFirstName)
      • employeeMiddleName

        public Form1095B employeeMiddleName​(String employeeMiddleName)
      • getEmployeeMiddleName

        @Nullable
        public String getEmployeeMiddleName()
        Employee's middle name
        Returns:
        employeeMiddleName
      • setEmployeeMiddleName

        public void setEmployeeMiddleName​(String employeeMiddleName)
      • employeeLastName

        public Form1095B employeeLastName​(String employeeLastName)
      • getEmployeeLastName

        @Nullable
        public String getEmployeeLastName()
        Employee's last name
        Returns:
        employeeLastName
      • setEmployeeLastName

        public void setEmployeeLastName​(String employeeLastName)
      • employeeNameSuffix

        public Form1095B employeeNameSuffix​(String employeeNameSuffix)
      • getEmployeeNameSuffix

        @Nullable
        public String getEmployeeNameSuffix()
        Employee's name suffix
        Returns:
        employeeNameSuffix
      • setEmployeeNameSuffix

        public void setEmployeeNameSuffix​(String employeeNameSuffix)
      • employeeDateOfBirth

        public Form1095B employeeDateOfBirth​(LocalDate employeeDateOfBirth)
      • getEmployeeDateOfBirth

        @Nullable
        public LocalDate getEmployeeDateOfBirth()
        Employee's date of birth
        Returns:
        employeeDateOfBirth
      • setEmployeeDateOfBirth

        public void setEmployeeDateOfBirth​(LocalDate employeeDateOfBirth)
      • getOriginOfHealthCoverageCode

        @Nullable
        public Form1095B.OriginOfHealthCoverageCodeEnum getOriginOfHealthCoverageCode()
        Origin of health coverage code. Available values: - A: Small Business Health Options Program (SHOP) - B: Employer-sponsored coverage - C: Government-sponsored program - D: Individual market insurance - E: Multiemployer plan - F: Other designated minimum essential coverage - G: Employer-sponsored coverage that is an individual coverage HRA (valid for tax years 2020 and later)
        Returns:
        originOfHealthCoverageCode
      • getCoveredIndividuals

        @Nullable
        public List<CoveredIndividual> getCoveredIndividuals()
        Covered individuals information - At least one month of coverage must be entered if it's not a correction.
        Returns:
        coveredIndividuals
      • setCoveredIndividuals

        public void setCoveredIndividuals​(List<CoveredIndividual> coveredIndividuals)
      • 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 Form1095B 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 Form1095B.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 Form1095B 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 Form1095B 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 Form1095B 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 Form1095B 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 Form1095B
      • fromJson

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

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