StripeAPI.Types.ReportingReportType

Contains the types generated from the schema ReportingReportType

Documentation

data Reporting'reportType

Defines the data type for the schema reporting.report_type

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 reports can only be run based on your live-mode data (not test-mode data), and thus related requests must be made with a live-mode API key.

Constructors

Reporting'reportType

Fields

• reporting'reportTypeDataAvailableEnd :: Integer

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

• reporting'reportTypeDataAvailableStart :: Integer

  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'reportTypeObject :: Reporting'reportTypeObject'

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

• reporting'reportTypeUpdated :: Integer

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

• reporting'reportTypeVersion :: Integer

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

Methods

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

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

Show Reporting'reportType

Defined in StripeAPI.Types.ReportingReportType

Methods

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

show :: Reporting'reportType -> String

showList :: [Reporting'reportType] -> ShowS

ToJSON Reporting'reportType

Defined in StripeAPI.Types.ReportingReportType

Methods

toJSON :: Reporting'reportType -> Value

toEncoding :: Reporting'reportType -> Encoding

toJSONList :: [Reporting'reportType] -> Value

toEncodingList :: [Reporting'reportType] -> Encoding

FromJSON Reporting'reportType

Defined in StripeAPI.Types.ReportingReportType

Methods

parseJSON :: Value -> Parser Reporting'reportType

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

data Reporting'reportTypeObject'

Defines the enum schema reporting.report_typeObject'

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

Constructors

Reporting'reportTypeObject'EnumOther Value

Reporting'reportTypeObject'EnumTyped Text

Reporting'reportTypeObject'EnumStringReporting'reportType

Instances

Eq Reporting'reportTypeObject'

Defined in StripeAPI.Types.ReportingReportType

Methods

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

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

Show Reporting'reportTypeObject'

Defined in StripeAPI.Types.ReportingReportType

Methods

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

show :: Reporting'reportTypeObject' -> String

showList :: [Reporting'reportTypeObject'] -> ShowS

ToJSON Reporting'reportTypeObject'

Defined in StripeAPI.Types.ReportingReportType

Methods

toJSON :: Reporting'reportTypeObject' -> Value

toEncoding :: Reporting'reportTypeObject' -> Encoding

toJSONList :: [Reporting'reportTypeObject'] -> Value

toEncodingList :: [Reporting'reportTypeObject'] -> Encoding

FromJSON Reporting'reportTypeObject'

Defined in StripeAPI.Types.ReportingReportType

Methods

parseJSON :: Value -> Parser Reporting'reportTypeObject'

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