Package Avalara.SDK.model.A1099.V2

Class FormRequestBase

java.lang.Object

Avalara.SDK.model.A1099.V2.FormRequestBase

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class FormRequestBase
extends Object

FormRequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormRequestBase.CustomTypeAdapterFactory
static class	FormRequestBase.TinTypeEnum	Type of TIN (Tax ID Number).

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ACCOUNT_NUMBER
static String	SERIALIZED_NAME_ADDRESS
static String	SERIALIZED_NAME_ADDRESS_VERIFICATION
static String	SERIALIZED_NAME_ADDRESS2
static String	SERIALIZED_NAME_CITY
static String	SERIALIZED_NAME_COUNTRY_CODE
static String	SERIALIZED_NAME_EMAIL
static String	SERIALIZED_NAME_FATCA_FILING_REQUIREMENT
static String	SERIALIZED_NAME_FEDERAL_E_FILE
static String	SERIALIZED_NAME_ISSUER_ID
static String	SERIALIZED_NAME_NO_TIN
static String	SERIALIZED_NAME_NON_US_PROVINCE
static String	SERIALIZED_NAME_OFFICE_CODE
static String	SERIALIZED_NAME_POSTAL_MAIL
static String	SERIALIZED_NAME_RECIPIENT_NAME
static String	SERIALIZED_NAME_RECIPIENT_SECOND_NAME
static String	SERIALIZED_NAME_RECIPIENT_TIN
static String	SERIALIZED_NAME_REFERENCE_ID
static String	SERIALIZED_NAME_SECOND_TIN_NOTICE
static String	SERIALIZED_NAME_STATE
static String	SERIALIZED_NAME_STATE_AND_LOCAL_WITHHOLDING
static String	SERIALIZED_NAME_STATE_E_FILE
static String	SERIALIZED_NAME_TIN_MATCH
static String	SERIALIZED_NAME_TIN_TYPE
static String	SERIALIZED_NAME_ZIP

Constructor Summary

Constructors

Constructor	Description
FormRequestBase()

Method Summary

Modifier and Type	Method	Description
FormRequestBase	accountNumber(String accountNumber)
FormRequestBase	address(String address)
FormRequestBase	address2(String address2)
FormRequestBase	addressVerification(Boolean addressVerification)
FormRequestBase	city(String city)
FormRequestBase	countryCode(String countryCode)
FormRequestBase	email(String email)
boolean	equals(Object o)
FormRequestBase	fatcaFilingRequirement(Boolean fatcaFilingRequirement)
FormRequestBase	federalEFile(Boolean federalEFile)
static FormRequestBase	fromJson(String jsonString)	Create an instance of FormRequestBase given an JSON string
String	getAccountNumber()	Account number
String	getAddress()	Address
String	getAddress2()	Address line 2
Boolean	getAddressVerification()	Boolean indicating that address verification should be scheduled for this form
String	getCity()	City
String	getCountryCode()	Country code, as defined at https://www.irs.gov/e-file-providers/country-codes
String	getEmail()	Recipient email address
Boolean	getFatcaFilingRequirement()	Fatca filing requirement
Boolean	getFederalEFile()	Boolean indicating that federal e-filing should be scheduled for this form
String	getIssuerId()	Issuer ID
String	getNonUsProvince()	Foreign province
Boolean	getNoTin()	Indicates whether the recipient has no TIN
String	getOfficeCode()	Office code
Boolean	getPostalMail()	Boolean indicating that postal mailing to the recipient should be scheduled for this form
String	getRecipientName()	Recipient name
String	getRecipientSecondName()	Recipient second name
String	getRecipientTin()	Recipient Tax ID Number
String	getReferenceId()	Reference ID
Boolean	getSecondTinNotice()	Second TIN notice in three years
String	getState()	US state.
StateAndLocalWithholdingRequest	getStateAndLocalWithholding()	State and local withholding information
Boolean	getStateEFile()	Boolean indicating that state e-filing should be scheduled for this form
Boolean	getTinMatch()	Boolean indicating that TIN Matching should be scheduled for this form
FormRequestBase.TinTypeEnum	getTinType()	Type of TIN (Tax ID Number).
String	getZip()	Zip/postal code
int	hashCode()
FormRequestBase	issuerId(String issuerId)
FormRequestBase	nonUsProvince(String nonUsProvince)
FormRequestBase	noTin(Boolean noTin)
FormRequestBase	officeCode(String officeCode)
FormRequestBase	postalMail(Boolean postalMail)
FormRequestBase	recipientName(String recipientName)
FormRequestBase	recipientSecondName(String recipientSecondName)
FormRequestBase	recipientTin(String recipientTin)
FormRequestBase	referenceId(String referenceId)
FormRequestBase	secondTinNotice(Boolean secondTinNotice)
void	setAccountNumber(String accountNumber)
void	setAddress(String address)
void	setAddress2(String address2)
void	setAddressVerification(Boolean addressVerification)
void	setCity(String city)
void	setCountryCode(String countryCode)
void	setEmail(String email)
void	setFatcaFilingRequirement(Boolean fatcaFilingRequirement)
void	setFederalEFile(Boolean federalEFile)
void	setIssuerId(String issuerId)
void	setNonUsProvince(String nonUsProvince)
void	setNoTin(Boolean noTin)
void	setOfficeCode(String officeCode)
void	setPostalMail(Boolean postalMail)
void	setRecipientName(String recipientName)
void	setRecipientSecondName(String recipientSecondName)
void	setRecipientTin(String recipientTin)
void	setReferenceId(String referenceId)
void	setSecondTinNotice(Boolean secondTinNotice)
void	setState(String state)
void	setStateAndLocalWithholding(StateAndLocalWithholdingRequest stateAndLocalWithholding)
void	setStateEFile(Boolean stateEFile)
void	setTinMatch(Boolean tinMatch)
void	setTinType(FormRequestBase.TinTypeEnum tinType)
void	setZip(String zip)
FormRequestBase	state(String state)
FormRequestBase	stateAndLocalWithholding(StateAndLocalWithholdingRequest stateAndLocalWithholding)
FormRequestBase	stateEFile(Boolean stateEFile)
FormRequestBase	tinMatch(Boolean tinMatch)
FormRequestBase	tinType(FormRequestBase.TinTypeEnum tinType)
String	toJson()	Convert an instance of FormRequestBase to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
FormRequestBase	zip(String zip)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ISSUER_ID

public static final String SERIALIZED_NAME_ISSUER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCE_ID

public static final String SERIALIZED_NAME_REFERENCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_RECIPIENT_TIN

public static final String SERIALIZED_NAME_RECIPIENT_TIN

See Also:

Constant Field Values

SERIALIZED_NAME_RECIPIENT_NAME

public static final String SERIALIZED_NAME_RECIPIENT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_TIN_TYPE

public static final String SERIALIZED_NAME_TIN_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_RECIPIENT_SECOND_NAME

public static final String SERIALIZED_NAME_RECIPIENT_SECOND_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS2

public static final String SERIALIZED_NAME_ADDRESS2

See Also:

Constant Field Values

SERIALIZED_NAME_CITY

public static final String SERIALIZED_NAME_CITY

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_ZIP

public static final String SERIALIZED_NAME_ZIP

See Also:

Constant Field Values

SERIALIZED_NAME_EMAIL

public static final String SERIALIZED_NAME_EMAIL

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_NUMBER

public static final String SERIALIZED_NAME_ACCOUNT_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_OFFICE_CODE

public static final String SERIALIZED_NAME_OFFICE_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_NON_US_PROVINCE

public static final String SERIALIZED_NAME_NON_US_PROVINCE

See Also:

Constant Field Values

SERIALIZED_NAME_COUNTRY_CODE

public static final String SERIALIZED_NAME_COUNTRY_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_FEDERAL_E_FILE

public static final String SERIALIZED_NAME_FEDERAL_E_FILE

See Also:

Constant Field Values

SERIALIZED_NAME_POSTAL_MAIL

public static final String SERIALIZED_NAME_POSTAL_MAIL

See Also:

Constant Field Values

SERIALIZED_NAME_STATE_E_FILE

public static final String SERIALIZED_NAME_STATE_E_FILE

See Also:

Constant Field Values

SERIALIZED_NAME_TIN_MATCH

public static final String SERIALIZED_NAME_TIN_MATCH

See Also:

Constant Field Values

SERIALIZED_NAME_NO_TIN

public static final String SERIALIZED_NAME_NO_TIN

See Also:

Constant Field Values

SERIALIZED_NAME_SECOND_TIN_NOTICE

public static final String SERIALIZED_NAME_SECOND_TIN_NOTICE

See Also:

Constant Field Values

SERIALIZED_NAME_FATCA_FILING_REQUIREMENT

public static final String SERIALIZED_NAME_FATCA_FILING_REQUIREMENT

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS_VERIFICATION

public static final String SERIALIZED_NAME_ADDRESS_VERIFICATION

See Also:

Constant Field Values

SERIALIZED_NAME_STATE_AND_LOCAL_WITHHOLDING

public static final String SERIALIZED_NAME_STATE_AND_LOCAL_WITHHOLDING

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

FormRequestBase

public FormRequestBase()

Method Detail

issuerId

public FormRequestBase issuerId(String issuerId)

getIssuerId

@Nullable
public String getIssuerId()

Issuer ID

Returns:

issuerId

setIssuerId

public void setIssuerId(String issuerId)

referenceId

public FormRequestBase referenceId(String referenceId)

getReferenceId

@Nullable
public String getReferenceId()

Reference ID

Returns:

referenceId

setReferenceId

public void setReferenceId(String referenceId)

recipientTin

public FormRequestBase recipientTin(String recipientTin)

getRecipientTin

@Nullable
public String getRecipientTin()

Recipient Tax ID Number

Returns:

recipientTin

setRecipientTin

public void setRecipientTin(String recipientTin)

recipientName

public FormRequestBase recipientName(String recipientName)

getRecipientName

@Nullable
public String getRecipientName()

Recipient name

Returns:

recipientName

setRecipientName

public void setRecipientName(String recipientName)

tinType

public FormRequestBase tinType(FormRequestBase.TinTypeEnum tinType)

getTinType

@Nullable
public FormRequestBase.TinTypeEnum getTinType()

Type of TIN (Tax ID Number). Will be one of: * SSN * EIN * ITIN * ATIN

Returns:

tinType

setTinType

public void setTinType(FormRequestBase.TinTypeEnum tinType)

recipientSecondName

public FormRequestBase recipientSecondName(String recipientSecondName)

getRecipientSecondName

@Nullable
public String getRecipientSecondName()

Recipient second name

Returns:

recipientSecondName

setRecipientSecondName

public void setRecipientSecondName(String recipientSecondName)

address

public FormRequestBase address(String address)

getAddress

@Nullable
public String getAddress()

Address

Returns:

address

setAddress

public void setAddress(String address)

address2

public FormRequestBase address2(String address2)

getAddress2

@Nullable
public String getAddress2()

Address line 2

Returns:

address2

setAddress2

public void setAddress2(String address2)

city

public FormRequestBase city(String city)

getCity

@Nullable
public String getCity()

City

Returns:

city

setCity

public void setCity(String city)

state

public FormRequestBase state(String state)

getState

@Nullable
public String getState()

US state. Required if CountryCode is \"US\".

Returns:

state

setState

public void setState(String state)

zip

public FormRequestBase zip(String zip)

getZip

@Nullable
public String getZip()

Zip/postal code

Returns:

zip

setZip

public void setZip(String zip)

email

public FormRequestBase email(String email)

getEmail

@Nullable
public String getEmail()

Recipient email address

Returns:

email

setEmail

public void setEmail(String email)

accountNumber

public FormRequestBase accountNumber(String accountNumber)

getAccountNumber

@Nullable
public String getAccountNumber()

Account number

Returns:

accountNumber

setAccountNumber

public void setAccountNumber(String accountNumber)

officeCode

public FormRequestBase officeCode(String officeCode)

getOfficeCode

@Nullable
public String getOfficeCode()

Office code

Returns:

officeCode

setOfficeCode

public void setOfficeCode(String officeCode)

nonUsProvince

public FormRequestBase nonUsProvince(String nonUsProvince)

getNonUsProvince

@Nullable
public String getNonUsProvince()

Foreign province

Returns:

nonUsProvince

setNonUsProvince

public void setNonUsProvince(String nonUsProvince)

countryCode

public FormRequestBase countryCode(String countryCode)

getCountryCode

@Nullable
public String getCountryCode()

Country code, as defined at https://www.irs.gov/e-file-providers/country-codes

Returns:

countryCode

setCountryCode

public void setCountryCode(String countryCode)

federalEFile

public FormRequestBase federalEFile(Boolean federalEFile)

getFederalEFile

@Nullable
public Boolean getFederalEFile()

Boolean indicating that federal e-filing should be scheduled for this form

Returns:

federalEFile

setFederalEFile

public void setFederalEFile(Boolean federalEFile)

postalMail

public FormRequestBase postalMail(Boolean postalMail)

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)

stateEFile

public FormRequestBase stateEFile(Boolean stateEFile)

getStateEFile

@Nullable
public Boolean getStateEFile()

Boolean indicating that state e-filing should be scheduled for this form

Returns:

stateEFile

setStateEFile

public void setStateEFile(Boolean stateEFile)

tinMatch

public FormRequestBase tinMatch(Boolean tinMatch)

getTinMatch

@Nullable
public Boolean getTinMatch()

Boolean indicating that TIN Matching should be scheduled for this form

Returns:

tinMatch

setTinMatch

public void setTinMatch(Boolean tinMatch)

noTin

public FormRequestBase noTin(Boolean noTin)

getNoTin

@Nullable
public Boolean getNoTin()

Indicates whether the recipient has no TIN

Returns:

noTin

setNoTin

public void setNoTin(Boolean noTin)

secondTinNotice

public FormRequestBase secondTinNotice(Boolean secondTinNotice)

getSecondTinNotice

@Nullable
public Boolean getSecondTinNotice()

Second TIN notice in three years

Returns:

secondTinNotice

setSecondTinNotice

public void setSecondTinNotice(Boolean secondTinNotice)

fatcaFilingRequirement

public FormRequestBase fatcaFilingRequirement(Boolean fatcaFilingRequirement)

getFatcaFilingRequirement

@Nullable
public Boolean getFatcaFilingRequirement()

Fatca filing requirement

Returns:

fatcaFilingRequirement

setFatcaFilingRequirement

public void setFatcaFilingRequirement(Boolean fatcaFilingRequirement)

addressVerification

public FormRequestBase 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)

stateAndLocalWithholding

public FormRequestBase stateAndLocalWithholding(StateAndLocalWithholdingRequest stateAndLocalWithholding)

getStateAndLocalWithholding

@Nullable
public StateAndLocalWithholdingRequest getStateAndLocalWithholding()

State and local withholding information

Returns:

stateAndLocalWithholding

setStateAndLocalWithholding

public void setStateAndLocalWithholding(StateAndLocalWithholdingRequest stateAndLocalWithholding)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString 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 FormRequestBase

fromJson

public static FormRequestBase fromJson(String jsonString)
                                throws IOException

Create an instance of FormRequestBase given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of FormRequestBase

Throws:

IOException - if the JSON string is invalid with respect to FormRequestBase

toJson

public String toJson()

Convert an instance of FormRequestBase to an JSON string

Returns:

JSON string