class

Plaid::Credit1099

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

An object representing an end user's 1099 tax form

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, document_id : String | Nil = nil, document_metadata : CreditDocumentMetadata | Nil = nil, form_1099_type : Plaid::Form1099Type | Nil = nil, recipient : Credit1099Recipient | Nil = nil, payer : Credit1099Payer | Nil = nil, filer : Credit1099Filer | Nil = nil, tax_year : String | Nil = nil, rents : Float64 | Nil = nil, royalties : Float64 | Nil = nil, other_income : Float64 | Nil = nil, federal_income_tax_withheld : Float64 | Nil = nil, fishing_boat_proceeds : Float64 | Nil = nil, medical_and_healthcare_payments : Float64 | Nil = nil, nonemployee_compensation : Float64 | Nil = nil, substitute_payments_in_lieu_of_dividends_or_interest : Float64 | Nil = nil, payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer : String | Nil = nil, crop_insurance_proceeds : Float64 | Nil = nil, excess_golden_parachute_payments : Float64 | Nil = nil, gross_proceeds_paid_to_an_attorney : Float64 | Nil = nil, section_409a_deferrals : Float64 | Nil = nil, section_409a_income : Float64 | Nil = nil, state_tax_withheld : Float64 | Nil = nil, state_tax_withheld_lower : Float64 | Nil = nil, payer_state_number : String | Nil = nil, payer_state_number_lower : String | Nil = nil, state_income : Float64 | Nil = nil, state_income_lower : Float64 | Nil = nil, transactions_reported : String | Nil = nil, pse_name : String | Nil = nil, pse_telephone_number : String | Nil = nil, gross_amount : Float64 | Nil = nil, card_not_present_transaction : Float64 | Nil = nil, merchant_category_code : String | Nil = nil, number_of_payment_transactions : String | Nil = nil, january_amount : Float64 | Nil = nil, february_amount : Float64 | Nil = nil, march_amount : Float64 | Nil = nil, april_amount : Float64 | Nil = nil, may_amount : Float64 | Nil = nil, june_amount : Float64 | Nil = nil, july_amount : Float64 | Nil = nil, august_amount : Float64 | Nil = nil, september_amount : Float64 | Nil = nil, october_amount : Float64 | Nil = nil, november_amount : Float64 | Nil = nil, december_amount : Float64 | Nil = nil, primary_state : String | Nil = nil, secondary_state : String | Nil = nil, primary_state_id : String | Nil = nil, secondary_state_id : String | Nil = nil, primary_state_income_tax : Float64 | Nil = nil, secondary_state_income_tax : Float64 | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

april_amount

Amount reported for April.

april_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] april_amount Object to be assigned

april_amount_present=(april_amount_present : Bool)

april_amount_present?

august_amount

Amount reported for August.

august_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] august_amount Object to be assigned

august_amount_present=(august_amount_present : Bool)

august_amount_present?

card_not_present_transaction

Amount in card not present transactions.

card_not_present_transaction=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] card_not_present_transaction Object to be assigned

card_not_present_transaction_present=(card_not_present_transaction_present : Bool)

card_not_present_transaction_present?

crop_insurance_proceeds

Amount of crop insurance proceeds.

crop_insurance_proceeds=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] crop_insurance_proceeds Object to be assigned

crop_insurance_proceeds_present=(crop_insurance_proceeds_present : Bool)

crop_insurance_proceeds_present?

december_amount

Amount reported for December.

december_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] december_amount Object to be assigned

december_amount_present=(december_amount_present : Bool)

december_amount_present?

document_id

An identifier of the document referenced by the document metadata.

document_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] document_id Object to be assigned

document_metadata

document_metadata=(new_value : CreditDocumentMetadata | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] document_metadata Object to be assigned

excess_golden_parachute_payments

Amount of golden parachute payments made by payer.

excess_golden_parachute_payments=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] excess_golden_parachute_payments Object to be assigned

excess_golden_parachute_payments_present=(excess_golden_parachute_payments_present : Bool)

excess_golden_parachute_payments_present?

february_amount

Amount reported for February.

february_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] february_amount Object to be assigned

february_amount_present=(february_amount_present : Bool)

february_amount_present?

federal_income_tax_withheld

Amount of federal income tax withheld from payer.

federal_income_tax_withheld=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] federal_income_tax_withheld Object to be assigned

federal_income_tax_withheld_present=(federal_income_tax_withheld_present : Bool)

federal_income_tax_withheld_present?

filer

filer=(new_value : Credit1099Filer | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] filer Object to be assigned

fishing_boat_proceeds

Amount of fishing boat proceeds from payer.

fishing_boat_proceeds=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] fishing_boat_proceeds Object to be assigned

fishing_boat_proceeds_present=(fishing_boat_proceeds_present : Bool)

fishing_boat_proceeds_present?

form_1099_type

form_1099_type=(new_value : Plaid::Form1099Type | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] form_1099_type Object to be assigned

gross_amount

Gross amount reported.

gross_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] gross_amount Object to be assigned

gross_amount_present=(gross_amount_present : Bool)

gross_amount_present?

gross_proceeds_paid_to_an_attorney

Amount of gross proceeds paid to an attorney by payer.

gross_proceeds_paid_to_an_attorney=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] gross_proceeds_paid_to_an_attorney Object to be assigned

gross_proceeds_paid_to_an_attorney_present=(gross_proceeds_paid_to_an_attorney_present : Bool)

gross_proceeds_paid_to_an_attorney_present?

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

january_amount

Amount reported for January.

january_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] january_amount Object to be assigned

january_amount_present=(january_amount_present : Bool)

january_amount_present?

july_amount

Amount reported for July.

july_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] july_amount Object to be assigned

july_amount_present=(july_amount_present : Bool)

july_amount_present?

june_amount

Amount reported for June.

june_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] june_amount Object to be assigned

june_amount_present=(june_amount_present : Bool)

june_amount_present?

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

march_amount

Amount reported for March.

march_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] march_amount Object to be assigned

march_amount_present=(march_amount_present : Bool)

march_amount_present?

may_amount

Amount reported for May.

may_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] may_amount Object to be assigned

may_amount_present=(may_amount_present : Bool)

may_amount_present?

medical_and_healthcare_payments

Amount of medical and healthcare payments from payer.

medical_and_healthcare_payments=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] medical_and_healthcare_payments Object to be assigned

medical_and_healthcare_payments_present=(medical_and_healthcare_payments_present : Bool)

medical_and_healthcare_payments_present?

merchant_category_code

Merchant category of filer.

merchant_category_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] merchant_category_code Object to be assigned

merchant_category_code_present=(merchant_category_code_present : Bool)

merchant_category_code_present?

nonemployee_compensation

Amount of nonemployee compensation from payer.

nonemployee_compensation=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] nonemployee_compensation Object to be assigned

nonemployee_compensation_present=(nonemployee_compensation_present : Bool)

nonemployee_compensation_present?

november_amount

Amount reported for November.

november_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] november_amount Object to be assigned

november_amount_present=(november_amount_present : Bool)

november_amount_present?

number_of_payment_transactions

Number of payment transactions made.

number_of_payment_transactions=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] number_of_payment_transactions Object to be assigned

number_of_payment_transactions_present=(number_of_payment_transactions_present : Bool)

number_of_payment_transactions_present?

october_amount

Amount reported for October.

october_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] october_amount Object to be assigned

october_amount_present=(october_amount_present : Bool)

october_amount_present?

other_income

Amount in other income by payer.

other_income=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] other_income Object to be assigned

other_income_present=(other_income_present : Bool)

other_income_present?

payer

payer=(new_value : Credit1099Payer | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payer Object to be assigned

payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer

Whether or not payer made direct sales over $5000 of consumer products.

payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer Object to be assigned

payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer_present=(payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer_present : Bool)

payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer_present?

payer_state_number

Primary state ID.

payer_state_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payer_state_number Object to be assigned

payer_state_number_lower

Secondary state ID.

payer_state_number_lower=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payer_state_number_lower Object to be assigned

payer_state_number_lower_present=(payer_state_number_lower_present : Bool)

payer_state_number_lower_present?

payer_state_number_present=(payer_state_number_present : Bool)

payer_state_number_present?

primary_state

Primary state of business.

primary_state=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] primary_state Object to be assigned

primary_state_id

Primary state ID.

primary_state_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] primary_state_id Object to be assigned

primary_state_id_present=(primary_state_id_present : Bool)

primary_state_id_present?

primary_state_income_tax

State income tax reported for primary state.

primary_state_income_tax=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] primary_state_income_tax Object to be assigned

primary_state_income_tax_present=(primary_state_income_tax_present : Bool)

primary_state_income_tax_present?

primary_state_present=(primary_state_present : Bool)

primary_state_present?

pse_name

Name of the PSE (Payment Settlement Entity).

pse_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] pse_name Object to be assigned

pse_name_present=(pse_name_present : Bool)

pse_name_present?

pse_telephone_number

Formatted (XXX) XXX-XXXX. Phone number of the PSE (Payment Settlement Entity).

pse_telephone_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] pse_telephone_number Object to be assigned

pse_telephone_number_present=(pse_telephone_number_present : Bool)

pse_telephone_number_present?

recipient

recipient=(new_value : Credit1099Recipient | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] recipient Object to be assigned

rents

Amount in rent by payer.

rents=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] rents Object to be assigned

rents_present=(rents_present : Bool)

rents_present?

royalties

Amount in royalties by payer.

royalties=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] royalties Object to be assigned

royalties_present=(royalties_present : Bool)

royalties_present?

secondary_state

Secondary state of business.

secondary_state=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] secondary_state Object to be assigned

secondary_state_id

Secondary state ID.

secondary_state_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] secondary_state_id Object to be assigned

secondary_state_id_present=(secondary_state_id_present : Bool)

secondary_state_id_present?

secondary_state_income_tax

State income tax reported for secondary state.

secondary_state_income_tax=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] secondary_state_income_tax Object to be assigned

secondary_state_income_tax_present=(secondary_state_income_tax_present : Bool)

secondary_state_income_tax_present?

secondary_state_present=(secondary_state_present : Bool)

secondary_state_present?

section_409a_deferrals

Amount of 409A deferrals earned by payer.

section_409a_deferrals=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] section_409a_deferrals Object to be assigned

section_409a_deferrals_present=(section_409a_deferrals_present : Bool)

section_409a_deferrals_present?

section_409a_income

Amount of 409A income earned by payer.

section_409a_income=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] section_409a_income Object to be assigned

section_409a_income_present=(section_409a_income_present : Bool)

section_409a_income_present?

september_amount

Amount reported for September.

september_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] september_amount Object to be assigned

september_amount_present=(september_amount_present : Bool)

september_amount_present?

state_income

State income reported for primary state.

state_income=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] state_income Object to be assigned

state_income_lower

State income reported for secondary state.

state_income_lower=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] state_income_lower Object to be assigned

state_income_lower_present=(state_income_lower_present : Bool)

state_income_lower_present?

state_income_present=(state_income_present : Bool)

state_income_present?

state_tax_withheld

Amount of state tax withheld of payer for primary state.

state_tax_withheld=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] state_tax_withheld Object to be assigned

state_tax_withheld_lower

Amount of state tax withheld of payer for secondary state.

state_tax_withheld_lower=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] state_tax_withheld_lower Object to be assigned

state_tax_withheld_lower_present=(state_tax_withheld_lower_present : Bool)

state_tax_withheld_lower_present?

state_tax_withheld_present=(state_tax_withheld_present : Bool)

state_tax_withheld_present?

substitute_payments_in_lieu_of_dividends_or_interest

Amount of substitute payments made by payer.

substitute_payments_in_lieu_of_dividends_or_interest=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] substitute_payments_in_lieu_of_dividends_or_interest Object to be assigned

substitute_payments_in_lieu_of_dividends_or_interest_present=(substitute_payments_in_lieu_of_dividends_or_interest_present : Bool)

substitute_payments_in_lieu_of_dividends_or_interest_present?

tax_year

Tax year of the tax form.

tax_year=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tax_year Object to be assigned

tax_year_present=(tax_year_present : Bool)

tax_year_present?

transactions_reported

One of the values will be provided Payment card Third party network

transactions_reported=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transactions_reported Object to be assigned

transactions_reported_present=(transactions_reported_present : Bool)

transactions_reported_present?

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid