Package com.stripe.model.tax

Class Form

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.tax.Form

All Implemented Interfaces:

HasId, StripeObjectInterface

public class Form
extends ApiResource
implements HasId

Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.

Related guide: US tax reporting for Connect platforms

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

Form.FilingStatus

static class

Form.Payee

ISO 3166-2 U.S.

static class

Form.Us1099K

static class

Form.Us1099Misc

static class

Form.Us1099Nec

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Form()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getCorrectedBy()	Get ID of expandable correctedBy object.
Form	getCorrectedByObject()	Get expanded correctedBy.
Long	getCreated()	Time at which the object was created.
List<Form.FilingStatus>	getFilingStatuses()	A list of tax filing statuses.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
Form.Payee	getPayee()
String	getType()	The type of the tax form.
Form.Us1099K	getUs1099K()
Form.Us1099Misc	getUs1099Misc()
Form.Us1099Nec	getUs1099Nec()
int	hashCode()
static FormCollection	list(FormListParams params)	Returns a list of tax forms which were previously created.
static FormCollection	list(FormListParams params, RequestOptions options)	Returns a list of tax forms which were previously created.
static FormCollection	list(Map<String,Object> params)	Returns a list of tax forms which were previously created.
static FormCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of tax forms which were previously created.
InputStream	pdf()	Download the PDF for a tax form.
InputStream	pdf(FormPdfParams params)	Download the PDF for a tax form.
InputStream	pdf(FormPdfParams params, RequestOptions options)	Download the PDF for a tax form.
InputStream	pdf(Map<String,Object> params)	Download the PDF for a tax form.
InputStream	pdf(Map<String,Object> params, RequestOptions options)	Download the PDF for a tax form.
static Form	retrieve(String id)	Retrieves the details of a tax form that has previously been created.
static Form	retrieve(String id, RequestOptions options)	Retrieves the details of a tax form that has previously been created.
static Form	retrieve(String id, FormRetrieveParams params, RequestOptions options)	Retrieves the details of a tax form that has previously been created.
static Form	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves the details of a tax form that has previously been created.
void	setCorrectedBy(String id)
void	setCorrectedByObject(Form expandableObject)
void	setCreated(Long created)	Time at which the object was created.
void	setFilingStatuses(List<Form.FilingStatus> filingStatuses)	A list of tax filing statuses.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setObject(String object)	String representing the object's type.
void	setPayee(Form.Payee payee)
void	setType(String type)	The type of the tax form.
void	setUs1099K(Form.Us1099K us1099K)
void	setUs1099Misc(Form.Us1099Misc us1099Misc)
void	setUs1099Nec(Form.Us1099Nec us1099Nec)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, rawRequest, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Form

public Form()

Method Details

getCorrectedBy

public String getCorrectedBy()

Get ID of expandable correctedBy object.

setCorrectedBy

public void setCorrectedBy(String id)

getCorrectedByObject

public Form getCorrectedByObject()

Get expanded correctedBy.

setCorrectedByObject

public void setCorrectedByObject(Form expandableObject)

list

public static FormCollection list(Map<String,Object> params)
                           throws StripeException

Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.

Throws:

StripeException

list

public static FormCollection list(Map<String,Object> params,
 RequestOptions options)
                           throws StripeException

Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.

Throws:

StripeException

list

public static FormCollection list(FormListParams params)
                           throws StripeException

Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.

Throws:

StripeException

list

public static FormCollection list(FormListParams params,
 RequestOptions options)
                           throws StripeException

Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.

Throws:

StripeException

pdf

public InputStream pdf()
                throws StripeException

Download the PDF for a tax form.

Throws:

StripeException

pdf

public InputStream pdf(Map<String,Object> params)
                throws StripeException

Download the PDF for a tax form.

Throws:

StripeException

pdf

public InputStream pdf(Map<String,Object> params,
 RequestOptions options)
                throws StripeException

Download the PDF for a tax form.

Throws:

StripeException

pdf

public InputStream pdf(FormPdfParams params)
                throws StripeException

Download the PDF for a tax form.

Throws:

StripeException

pdf

public InputStream pdf(FormPdfParams params,
 RequestOptions options)
                throws StripeException

Download the PDF for a tax form.

Throws:

StripeException

retrieve

public static Form retrieve(String id)
                     throws StripeException

Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.

Throws:

StripeException

retrieve

public static Form retrieve(String id,
 RequestOptions options)
                     throws StripeException

Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.

Throws:

StripeException

retrieve

public static Form retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.

Throws:

StripeException

retrieve

public static Form retrieve(String id,
 FormRetrieveParams params,
 RequestOptions options)
                     throws StripeException

Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.

Throws:

StripeException

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getFilingStatuses

public List<Form.FilingStatus> getFilingStatuses()

A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to tax.form.

getPayee

public Form.Payee getPayee()

getType

public String getType()

The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.

One of us_1099_k, us_1099_misc, or us_1099_nec.

getUs1099K

public Form.Us1099K getUs1099K()

getUs1099Misc

public Form.Us1099Misc getUs1099Misc()

getUs1099Nec

public Form.Us1099Nec getUs1099Nec()

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setFilingStatuses

public void setFilingStatuses(List<Form.FilingStatus> filingStatuses)

A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to tax.form.

setPayee

public void setPayee(Form.Payee payee)

setType

public void setType(String type)

The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.

One of us_1099_k, us_1099_misc, or us_1099_nec.

setUs1099K

public void setUs1099K(Form.Us1099K us1099K)

setUs1099Misc

public void setUs1099Misc(Form.Us1099Misc us1099Misc)

setUs1099Nec

public void setUs1099Nec(Form.Us1099Nec us1099Nec)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId