Package Avalara.SDK.model.A1099.V2

Class FormRequestModel

java.lang.Object

Avalara.SDK.model.A1099.V2.FormRequestModel

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

FormRequestModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormRequestModel.CustomTypeAdapterFactory
static class	FormRequestModel.FormTypeEnum	\"W9\" is currently the only supported value
static class	FormRequestModel.TinMatchStatusEnum	Result of IRS TIN match query for name and TIN in the last signed form, null if signed_at is null
static class	FormRequestModel.TypeEnum	Gets or Sets type

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_COMPANY_EMAIL
static String	SERIALIZED_NAME_COMPANY_ID
static String	SERIALIZED_NAME_COMPANY_NAME
static String	SERIALIZED_NAME_EXPIRES_AT
static String	SERIALIZED_NAME_FORM_TYPE
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_REFERENCE_ID
static String	SERIALIZED_NAME_SIGNED_AT
static String	SERIALIZED_NAME_SIGNED_PDF
static String	SERIALIZED_NAME_TIN_MATCH_STATUS
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor	Description
FormRequestModel()

Method Summary

Modifier and Type	Method	Description
FormRequestModel	companyEmail(String companyEmail)
FormRequestModel	companyId(Integer companyId)
FormRequestModel	companyName(String companyName)
boolean	equals(Object o)
FormRequestModel	expiresAt(OffsetDateTime expiresAt)
FormRequestModel	formType(FormRequestModel.FormTypeEnum formType)
static FormRequestModel	fromJson(String jsonString)	Create an instance of FormRequestModel given an JSON string
String	getCompanyEmail()	Contact email of your company, set in the W-9 UI
Integer	getCompanyId()	Track1099's ID of your company, found in the W-9 UI
String	getCompanyName()	Name of your company, set in the W-9 UI
OffsetDateTime	getExpiresAt()	Timestamp when this FormRequest will expire, ttl (or 3600) seconds from creation
FormRequestModel.FormTypeEnum	getFormType()	\"W9\" is currently the only supported value
String	getId()	Get id
String	getReferenceId()	Your internal identifier for the vendor from whom you are requesting a form
OffsetDateTime	getSignedAt()	The timestamp this vendor (identified by your ReferenceId) last signed a complete W-9, null if you did not include a ReferenceId or the vendor has not yet signed a W-9 in Track1099
String	getSignedPdf()	URL of PDF representation of just-signed form, otherwise null.
FormRequestModel.TinMatchStatusEnum	getTinMatchStatus()	Result of IRS TIN match query for name and TIN in the last signed form, null if signed_at is null
FormRequestModel.TypeEnum	getType()	Get type
int	hashCode()
FormRequestModel	id(String id)
FormRequestModel	referenceId(String referenceId)
void	setCompanyEmail(String companyEmail)
void	setCompanyId(Integer companyId)
void	setCompanyName(String companyName)
void	setExpiresAt(OffsetDateTime expiresAt)
void	setFormType(FormRequestModel.FormTypeEnum formType)
void	setId(String id)
void	setReferenceId(String referenceId)
void	setSignedAt(OffsetDateTime signedAt)
void	setSignedPdf(String signedPdf)
void	setTinMatchStatus(FormRequestModel.TinMatchStatusEnum tinMatchStatus)
void	setType(FormRequestModel.TypeEnum type)
FormRequestModel	signedAt(OffsetDateTime signedAt)
FormRequestModel	signedPdf(String signedPdf)
FormRequestModel	tinMatchStatus(FormRequestModel.TinMatchStatusEnum tinMatchStatus)
String	toJson()	Convert an instance of FormRequestModel to an JSON string
String	toString()
FormRequestModel	type(FormRequestModel.TypeEnum type)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_FORM_TYPE

public static final String SERIALIZED_NAME_FORM_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_COMPANY_ID

public static final String SERIALIZED_NAME_COMPANY_ID

See Also:

Constant Field Values

SERIALIZED_NAME_COMPANY_NAME

public static final String SERIALIZED_NAME_COMPANY_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_COMPANY_EMAIL

public static final String SERIALIZED_NAME_COMPANY_EMAIL

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCE_ID

public static final String SERIALIZED_NAME_REFERENCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SIGNED_AT

public static final String SERIALIZED_NAME_SIGNED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_TIN_MATCH_STATUS

public static final String SERIALIZED_NAME_TIN_MATCH_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRES_AT

public static final String SERIALIZED_NAME_EXPIRES_AT

See Also:

Constant Field Values

SERIALIZED_NAME_SIGNED_PDF

public static final String SERIALIZED_NAME_SIGNED_PDF

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

FormRequestModel

public FormRequestModel()

Method Detail

id

public FormRequestModel id(String id)

getId

@Nullable
public String getId()

Get id

Returns:

id

setId

public void setId(String id)

type

public FormRequestModel type(FormRequestModel.TypeEnum type)

getType

@Nullable
public FormRequestModel.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(FormRequestModel.TypeEnum type)

formType

public FormRequestModel formType(FormRequestModel.FormTypeEnum formType)

getFormType

@Nullable
public FormRequestModel.FormTypeEnum getFormType()

\"W9\" is currently the only supported value

Returns:

formType

setFormType

public void setFormType(FormRequestModel.FormTypeEnum formType)

companyId

public FormRequestModel companyId(Integer companyId)

getCompanyId

@Nullable
public Integer getCompanyId()

Track1099's ID of your company, found in the W-9 UI

Returns:

companyId

setCompanyId

public void setCompanyId(Integer companyId)

companyName

public FormRequestModel companyName(String companyName)

getCompanyName

@Nullable
public String getCompanyName()

Name of your company, set in the W-9 UI

Returns:

companyName

setCompanyName

public void setCompanyName(String companyName)

companyEmail

public FormRequestModel companyEmail(String companyEmail)

getCompanyEmail

@Nullable
public String getCompanyEmail()

Contact email of your company, set in the W-9 UI

Returns:

companyEmail

setCompanyEmail

public void setCompanyEmail(String companyEmail)

referenceId

public FormRequestModel referenceId(String referenceId)

getReferenceId

@Nullable
public String getReferenceId()

Your internal identifier for the vendor from whom you are requesting a form

Returns:

referenceId

setReferenceId

public void setReferenceId(String referenceId)

signedAt

public FormRequestModel signedAt(OffsetDateTime signedAt)

getSignedAt

@Nullable
public OffsetDateTime getSignedAt()

The timestamp this vendor (identified by your ReferenceId) last signed a complete W-9, null if you did not include a ReferenceId or the vendor has not yet signed a W-9 in Track1099

Returns:

signedAt

setSignedAt

public void setSignedAt(OffsetDateTime signedAt)

tinMatchStatus

public FormRequestModel tinMatchStatus(FormRequestModel.TinMatchStatusEnum tinMatchStatus)

getTinMatchStatus

@Nullable
public FormRequestModel.TinMatchStatusEnum getTinMatchStatus()

Result of IRS TIN match query for name and TIN in the last signed form, null if signed_at is null

Returns:

tinMatchStatus

setTinMatchStatus

public void setTinMatchStatus(FormRequestModel.TinMatchStatusEnum tinMatchStatus)

expiresAt

public FormRequestModel expiresAt(OffsetDateTime expiresAt)

getExpiresAt

@Nullable
public OffsetDateTime getExpiresAt()

Timestamp when this FormRequest will expire, ttl (or 3600) seconds from creation

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(OffsetDateTime expiresAt)

signedPdf

public FormRequestModel signedPdf(String signedPdf)

getSignedPdf

@Nullable
public String getSignedPdf()

URL of PDF representation of just-signed form, otherwise null. Integrations may use this value to offer a \"download for your records\" function after a vendor completes and signs a form. Link expires at the same time as this FormRequest. Treat the format of this URL as opaque and expect it to change in the future.

Returns:

signedPdf

setSignedPdf

public void setSignedPdf(String signedPdf)

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 FormRequestModel

fromJson

public static FormRequestModel fromJson(String jsonString)
                                 throws IOException

Create an instance of FormRequestModel given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of FormRequestModel

Throws:

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

toJson

public String toJson()

Convert an instance of FormRequestModel to an JSON string

Returns:

JSON string