Mayson Monorepo Documentation
    Preparing search index...

    Interface Parameters

    interface Parameters {
        columns?: string[];
        connected_account?: string;
        currency?: string;
        interval_end?: number;
        interval_start?: number;
        payout?: string;
        reporting_category?: string;
        timezone?: string;
    }
    Index

    Properties

    columns? connected_account? currency? interval_end? interval_start? payout? reporting_category? timezone?

    Properties

    columns?: string[]

    The set of output columns requested for inclusion in the report run.

    connected_account?: string

    Connected account ID by which to filter the report run.

    currency?: string

    Currency of objects to be included in the report run.

    interval_end?: number

    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.

    interval_start?: number

    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.

    payout?: string

    Payout ID by which to filter the report run.

    reporting_category?: string

    Category of balance transactions to be included in the report run.

    timezone?: string

    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.

    Settings

    Member Visibility

    On This Page

    Properties