Stripe.Resources.Reporting.ReportRun (tiger_stripe v0.3.0)

Copy Markdown View Source

reporting_report_run

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.

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.

Summary

Types

parameters()
t()

Functions

expandable_fields()
object_name()

Types

parameters()

@type parameters() :: %{
  optional(:columns) => [String.t()] | nil,
  optional(:connected_account) => String.t() | nil,
  optional(:currency) => String.t() | nil,
  optional(:interval_end) => integer() | nil,
  optional(:interval_start) => integer() | nil,
  optional(:payout) => String.t() | nil,
  optional(:reporting_category) => String.t() | nil,
  optional(:timezone) => String.t() | nil,
  optional(String.t()) => term()
}
  • columns - The set of output columns requested for inclusion in the report run.
  • connected_account - Connected account ID by which to filter the report run. Max length: 5000.
  • currency - Currency of objects to be included in the report run. Format: ISO 4217 currency code.
  • interval_end - Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified interval_start and 1 second before this report's last data_available_end value. Format: Unix timestamp.
  • interval_start - Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's data_available_start and 1 second before the user specified interval_end value. Format: Unix timestamp.
  • payout - Payout ID by which to filter the report run. Max length: 5000.
  • reporting_category - Category of balance transactions to be included in the report run. Max length: 5000.
  • timezone - Defaults to Etc/UTC. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the IANA Time Zone Database. Has no effect on interval_start or interval_end. Max length: 5000.

t()

@type t() :: %Stripe.Resources.Reporting.ReportRun{
  created: integer(),
  error: String.t(),
  id: String.t(),
  livemode: boolean(),
  object: String.t(),
  parameters: parameters(),
  report_type: String.t(),
  result: Stripe.Resources.File.t(),
  status: String.t(),
  succeeded_at: integer()
}
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • error - If something should go wrong during the run, a message about the failure (populated when status=failed). Max length: 5000. Nullable.
  • id - Unique identifier for the object. Max length: 5000.
  • livemode - true if the report is run on live mode data and false if it is run on test mode data.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: reporting.report_run.
  • parameters - Expandable.
  • report_type - The ID of the report type to run, such as "balance.summary.1". Max length: 5000.
  • result - The file object representing the result of the report run (populated when status=succeeded). Nullable. Expandable.
  • status - Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated. Max length: 5000.
  • succeeded_at - Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch. Format: Unix timestamp. Nullable.

Functions

expandable_fields()

object_name()