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
,StripeActiveObject
,StripeObjectInterface
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
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
Field Summary
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON, INTERNAL_GSON
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Get ID of expandablecorrectedBy
object.Get expandedcorrectedBy
.Time at which the object was created.A list of tax filing statuses.getId()
Unique identifier for the object.Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.String representing the object's type.getPayee()
getType()
The type of the tax form.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
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.pdf()
Download the PDF for a tax form.pdf
(FormPdfParams params) Download the PDF for a tax form.pdf
(FormPdfParams params, RequestOptions options) Download the PDF for a tax form.Download the PDF for a tax form.pdf
(Map<String, Object> params, RequestOptions options) Download the PDF for a tax form.static Form
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
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
Unique identifier for the object.void
setLivemode
(Boolean livemode) Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
String representing the object's type.void
setPayee
(Form.Payee payee) void
setResponseGetter
(StripeResponseGetter responseGetter) Method is used by the containing object orStripeResponseGetter
implementations to set theStripeResponseGetter
instance used to make further requests.void
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, getGlobalResponseGetter, getResponseGetter, rawRequest, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.stripe.model.StripeActiveObject
trySetResponseGetter
-
Constructor Details
-
Form
public Form()
-
-
Method Details
-
getCorrectedBy
Get ID of expandablecorrectedBy
object. -
setCorrectedBy
-
getCorrectedByObject
Get expandedcorrectedBy
. -
setCorrectedByObject
-
list
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 StripeExceptionReturns 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
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
Download the PDF for a tax form.- Throws:
StripeException
-
pdf
Download the PDF for a tax form.- Throws:
StripeException
-
pdf
Download the PDF for a tax form.- Throws:
StripeException
-
pdf
Download the PDF for a tax form.- Throws:
StripeException
-
pdf
Download the PDF for a tax form.- Throws:
StripeException
-
retrieve
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
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 StripeExceptionRetrieves 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
-
setResponseGetter
Description copied from interface:StripeActiveObject
Method is used by the containing object orStripeResponseGetter
implementations to set theStripeResponseGetter
instance used to make further requests.- Specified by:
setResponseGetter
in interfaceStripeActiveObject
- Overrides:
setResponseGetter
in classApiResource
- Parameters:
responseGetter
- theStripeResponseGetter
instance to use for making further requests.
-
getCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
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
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
tax.form
. -
getPayee
-
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
, orus_1099_nec
. -
getUs1099K
-
getUs1099Misc
-
getUs1099Nec
-
setCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
setFilingStatuses
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
Unique identifier for the object. -
setLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
tax.form
. -
setPayee
-
setType
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
, orus_1099_nec
. -
setUs1099K
-
setUs1099Misc
-
setUs1099Nec
-
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-