View Source ExOAPI.Stripe.Schemas.Reporting_reportType (exoapi_stripe v0.1.4)

description: The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.

Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

:data_available_end :: :integer

Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

:data_available_start :: :integer

Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

::default_columns :: :string

:id :: :string

The ID of the Report Type, such as balance.summary.1.

:livemode :: :boolean

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

:name :: :string

Human-readable name of the Report Type

:object :: :string

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

:updated :: :integer

When this Report Type was latest updated. Measured in seconds since the Unix epoch.

:version :: :integer

Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.

Link to this section Summary

Link to this section Types

@type params() :: map()
@type t() :: %ExOAPI.Stripe.Schemas.Reporting_reportType{
  data_available_end: integer() | nil,
  data_available_start: integer() | nil,
  default_columns: [String.t()] | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  name: String.t() | nil,
  object: :"reporting.report_type" | nil,
  updated: integer() | nil,
  version: integer() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source
@spec changeset(t(), params()) :: Ecto.Changeset.t()