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 classFormRequestBase.CustomTypeAdapterFactorystatic classFormRequestBase.TinTypeEnumType of TIN (Tax ID Number).
-
Field Summary
-
Constructor Summary
Constructors Constructor Description FormRequestBase()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FormRequestBaseaccountNumber(String accountNumber)FormRequestBaseaddress(String address)FormRequestBaseaddress2(String address2)FormRequestBaseaddressVerification(Boolean addressVerification)FormRequestBasecity(String city)FormRequestBasecountryCode(String countryCode)booleanequals(Object o)FormRequestBasefederalEFile(Boolean federalEFile)static FormRequestBasefromJson(String jsonString)Create an instance of FormRequestBase given an JSON stringStringgetAccountNumber()Account numberStringgetAddress()AddressStringgetAddress2()Address line 2BooleangetAddressVerification()Boolean indicating that address verification should be scheduled for this formStringgetCity()CityStringgetCountryCode()Country code, as defined at https://www.irs.gov/e-file-providers/country-codesBooleangetFederalEFile()Boolean indicating that federal e-filing should be scheduled for this formStringgetIssuerId()Issuer IDStringgetOfficeCode()Office codeBooleangetPostalMail()Boolean indicating that postal mailing to the recipient should be scheduled for this formStringgetRecipientEmail()Recipient email addressStringgetRecipientName()Recipient nameStringgetRecipientNonUsProvince()Foreign provinceStringgetRecipientSecondName()Recipient second nameStringgetRecipientTin()Recipient Tax ID NumberStringgetReferenceId()Reference IDStringgetState()US state.StateAndLocalWithholdingRequestgetStateAndLocalWithholding()State and local withholding informationBooleangetStateEFile()Boolean indicating that state e-filing should be scheduled for this formBooleangetTinMatch()Boolean indicating that TIN Matching should be scheduled for this formFormRequestBase.TinTypeEnumgetTinType()Type of TIN (Tax ID Number).StringgetZip()Zip/postal codeinthashCode()FormRequestBaseissuerId(String issuerId)FormRequestBaseofficeCode(String officeCode)FormRequestBasepostalMail(Boolean postalMail)FormRequestBaserecipientEmail(String recipientEmail)FormRequestBaserecipientName(String recipientName)FormRequestBaserecipientNonUsProvince(String recipientNonUsProvince)FormRequestBaserecipientSecondName(String recipientSecondName)FormRequestBaserecipientTin(String recipientTin)FormRequestBasereferenceId(String referenceId)voidsetAccountNumber(String accountNumber)voidsetAddress(String address)voidsetAddress2(String address2)voidsetAddressVerification(Boolean addressVerification)voidsetCity(String city)voidsetCountryCode(String countryCode)voidsetFederalEFile(Boolean federalEFile)voidsetIssuerId(String issuerId)voidsetOfficeCode(String officeCode)voidsetPostalMail(Boolean postalMail)voidsetRecipientEmail(String recipientEmail)voidsetRecipientName(String recipientName)voidsetRecipientNonUsProvince(String recipientNonUsProvince)voidsetRecipientSecondName(String recipientSecondName)voidsetRecipientTin(String recipientTin)voidsetReferenceId(String referenceId)voidsetState(String state)voidsetStateAndLocalWithholding(StateAndLocalWithholdingRequest stateAndLocalWithholding)voidsetStateEFile(Boolean stateEFile)voidsetTinMatch(Boolean tinMatch)voidsetTinType(FormRequestBase.TinTypeEnum tinType)voidsetZip(String zip)FormRequestBasestate(String state)FormRequestBasestateAndLocalWithholding(StateAndLocalWithholdingRequest stateAndLocalWithholding)FormRequestBasestateEFile(Boolean stateEFile)FormRequestBasetinMatch(Boolean tinMatch)FormRequestBasetinType(FormRequestBase.TinTypeEnum tinType)StringtoJson()Convert an instance of FormRequestBase to an JSON stringStringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement)Validates the JSON Element and throws an exception if issues foundFormRequestBasezip(String zip)
-
-
-
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_RECIPIENT_EMAIL
public static final String SERIALIZED_NAME_RECIPIENT_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_RECIPIENT_NON_US_PROVINCE
public static final String SERIALIZED_NAME_RECIPIENT_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_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
-
-
Method Detail
-
issuerId
public FormRequestBase issuerId(String issuerId)
-
setIssuerId
public void setIssuerId(String issuerId)
-
referenceId
public FormRequestBase referenceId(String 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)
-
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)
-
setAddress
public void setAddress(String address)
-
address2
public FormRequestBase address2(String address2)
-
setAddress2
public void setAddress2(String address2)
-
city
public FormRequestBase city(String 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)
-
setZip
public void setZip(String zip)
-
recipientEmail
public FormRequestBase recipientEmail(String recipientEmail)
-
getRecipientEmail
@Nullable public String getRecipientEmail()
Recipient email address- Returns:
- recipientEmail
-
setRecipientEmail
public void setRecipientEmail(String recipientEmail)
-
accountNumber
public FormRequestBase accountNumber(String accountNumber)
-
setAccountNumber
public void setAccountNumber(String accountNumber)
-
officeCode
public FormRequestBase officeCode(String officeCode)
-
setOfficeCode
public void setOfficeCode(String officeCode)
-
recipientNonUsProvince
public FormRequestBase recipientNonUsProvince(String recipientNonUsProvince)
-
getRecipientNonUsProvince
@Nullable public String getRecipientNonUsProvince()
Foreign province- Returns:
- recipientNonUsProvince
-
setRecipientNonUsProvince
public void setRecipientNonUsProvince(String recipientNonUsProvince)
-
countryCode
public FormRequestBase countryCode(String countryCode)
-
getCountryCode
@Nonnull 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)
-
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)
-
validateJsonElement
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOExceptionValidates 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
-
-