StripeAPI.Types.Reporting_ReportType

Contains the types generated from the schema Reporting_ReportType

Documentation

data Reporting'reportType

Defines the object schema located at components.schemas.reporting.report_type in the specification.

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.

Constructors

Reporting'reportType

Fields

• reporting'reportTypeDataAvailableEnd :: Int

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

• reporting'reportTypeDataAvailableStart :: Int

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

• reporting'reportTypeDefaultColumns :: Maybe [Text]

  default_columns: List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)

• reporting'reportTypeId :: Text

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

  Constraints:

  • Maximum length of 5000
• reporting'reportTypeName :: Text

  name: Human-readable name of the Report Type

  Constraints:

  • Maximum length of 5000
• reporting'reportTypeUpdated :: Int

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

• reporting'reportTypeVersion :: Int

  version: 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.

Instances

Eq Reporting'reportType

Defined in StripeAPI.Types.Reporting_ReportType

Methods

(==) :: Reporting'reportType -> Reporting'reportType -> Bool

(/=) :: Reporting'reportType -> Reporting'reportType -> Bool

Show Reporting'reportType

Defined in StripeAPI.Types.Reporting_ReportType

Methods

showsPrec :: Int -> Reporting'reportType -> ShowS

show :: Reporting'reportType -> String

showList :: [Reporting'reportType] -> ShowS

ToJSON Reporting'reportType

Defined in StripeAPI.Types.Reporting_ReportType

Methods

toJSON :: Reporting'reportType -> Value

toEncoding :: Reporting'reportType -> Encoding

toJSONList :: [Reporting'reportType] -> Value

toEncodingList :: [Reporting'reportType] -> Encoding

FromJSON Reporting'reportType

Defined in StripeAPI.Types.Reporting_ReportType

Methods

parseJSON :: Value -> Parser Reporting'reportType

parseJSONList :: Value -> Parser [Reporting'reportType]

mkReporting'reportType

Arguments

:: Int

reporting'reportTypeDataAvailableEnd

-> Int

reporting'reportTypeDataAvailableStart

-> Text

reporting'reportTypeId

-> Text

reporting'reportTypeName

-> Int

reporting'reportTypeUpdated

-> Int

reporting'reportTypeVersion

-> Reporting'reportType

Create a new Reporting'reportType with all required fields.