Class Form1099K


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               comments="Generator version: 7.7.0")
    public class Form1099K
    extends Object
    Form 1099-K: Payment Card and Third Party Network Transactions
    • Method Detail

      • getFilerType

        @Nullable
        public Form1099K.FilerTypeEnum getFilerType()
        Filer type for tax reporting purposes. Available values: - PSE: Payment Settlement Entity - EPF: Electronic Payment Facilitator or other third party
        Returns:
        filerType
      • getPaymentType

        @Nullable
        public Form1099K.PaymentTypeEnum getPaymentType()
        Payment type for transaction classification. Available values: - PaymentCard: Payment card transactions - ThirdPartyNetwork: Third party network transactions
        Returns:
        paymentType
      • paymentSettlementEntityNamePhoneNumber

        public Form1099K paymentSettlementEntityNamePhoneNumber​(String paymentSettlementEntityNamePhoneNumber)
      • getPaymentSettlementEntityNamePhoneNumber

        @Nullable
        public String getPaymentSettlementEntityNamePhoneNumber()
        Payment settlement entity name and phone number, if different from Filer's
        Returns:
        paymentSettlementEntityNamePhoneNumber
      • setPaymentSettlementEntityNamePhoneNumber

        public void setPaymentSettlementEntityNamePhoneNumber​(String paymentSettlementEntityNamePhoneNumber)
      • grossAmountPaymentCard

        public Form1099K grossAmountPaymentCard​(Double grossAmountPaymentCard)
      • getGrossAmountPaymentCard

        @Nullable
        public Double getGrossAmountPaymentCard()
        Gross amount of payment card/third party network transactions. This value must equal the total of all monthly payment amounts (January through December).
        Returns:
        grossAmountPaymentCard
      • setGrossAmountPaymentCard

        public void setGrossAmountPaymentCard​(Double grossAmountPaymentCard)
      • cardNotPresentTransactions

        public Form1099K cardNotPresentTransactions​(Double cardNotPresentTransactions)
      • getCardNotPresentTransactions

        @Nullable
        public Double getCardNotPresentTransactions()
        Card not present transactions
        Returns:
        cardNotPresentTransactions
      • setCardNotPresentTransactions

        public void setCardNotPresentTransactions​(Double cardNotPresentTransactions)
      • merchantCategoryCode

        public Form1099K merchantCategoryCode​(String merchantCategoryCode)
      • getMerchantCategoryCode

        @Nullable
        public String getMerchantCategoryCode()
        Merchant category code (4 numbers)
        Returns:
        merchantCategoryCode
      • setMerchantCategoryCode

        public void setMerchantCategoryCode​(String merchantCategoryCode)
      • paymentTransactionNumber

        public Form1099K paymentTransactionNumber​(Double paymentTransactionNumber)
      • getPaymentTransactionNumber

        @Nullable
        public Double getPaymentTransactionNumber()
        Number of payment transactions
        Returns:
        paymentTransactionNumber
      • setPaymentTransactionNumber

        public void setPaymentTransactionNumber​(Double paymentTransactionNumber)
      • federalIncomeTaxWithheld

        public Form1099K federalIncomeTaxWithheld​(Double federalIncomeTaxWithheld)
      • getFederalIncomeTaxWithheld

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

        public void setFederalIncomeTaxWithheld​(Double federalIncomeTaxWithheld)
      • getJanuary

        @Nullable
        public Double getJanuary()
        January gross payments
        Returns:
        january
      • setJanuary

        public void setJanuary​(Double january)
      • getFebruary

        @Nullable
        public Double getFebruary()
        February gross payments
        Returns:
        february
      • setFebruary

        public void setFebruary​(Double february)
      • getMarch

        @Nullable
        public Double getMarch()
        March gross payments
        Returns:
        march
      • setMarch

        public void setMarch​(Double march)
      • getApril

        @Nullable
        public Double getApril()
        April gross payments
        Returns:
        april
      • setApril

        public void setApril​(Double april)
      • getMay

        @Nullable
        public Double getMay()
        May gross payments
        Returns:
        may
      • setMay

        public void setMay​(Double may)
      • getJune

        @Nullable
        public Double getJune()
        June gross payments
        Returns:
        june
      • setJune

        public void setJune​(Double june)
      • getJuly

        @Nullable
        public Double getJuly()
        July gross payments
        Returns:
        july
      • setJuly

        public void setJuly​(Double july)
      • getAugust

        @Nullable
        public Double getAugust()
        August gross payments
        Returns:
        august
      • setAugust

        public void setAugust​(Double august)
      • getSeptember

        @Nullable
        public Double getSeptember()
        September gross payments
        Returns:
        september
      • setSeptember

        public void setSeptember​(Double september)
      • getOctober

        @Nullable
        public Double getOctober()
        October gross payments
        Returns:
        october
      • setOctober

        public void setOctober​(Double october)
      • getNovember

        @Nullable
        public Double getNovember()
        November gross payments
        Returns:
        november
      • setNovember

        public void setNovember​(Double november)
      • getDecember

        @Nullable
        public Double getDecember()
        December gross payments
        Returns:
        december
      • setDecember

        public void setDecember​(Double december)
      • 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 Form1099K 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 Form1099K.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 Form1099K 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 Form1099K 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 Form1099K 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 Form1099K 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 Form1099K
      • fromJson

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

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