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

  • 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

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAuSerr

      public Form.AuSerr getAuSerr()

    • getCaMrdp

      public Form.CaMrdp getCaMrdp()

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getEuDac7

      public Form.EuDac7 getEuDac7()

    • 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.

    • getGbMrdp

      public Form.GbMrdp getGbMrdp()

    • 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.

    • getNzMrdp

      public Form.NzMrdp getNzMrdp()

    • 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 au_serr, ca_mrdp, eu_dac7, gb_mrdp, nz_mrdp, 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()

    • setAuSerr

      public void setAuSerr(Form.AuSerr auSerr)

    • setCaMrdp

      public void setCaMrdp(Form.CaMrdp caMrdp)

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setEuDac7

      public void setEuDac7(Form.EuDac7 euDac7)

    • 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.

    • setGbMrdp

      public void setGbMrdp(Form.GbMrdp gbMrdp)

    • 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.

    • setNzMrdp

      public void setNzMrdp(Form.NzMrdp nzMrdp)

    • 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 au_serr, ca_mrdp, eu_dac7, gb_mrdp, nz_mrdp, 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