Interface ReportRunsApiListReportRunsRequest

Request parameters for listReportRuns operation in ReportRunsApi.

Export

ReportRunsApiListReportRunsRequest

Hierarchy

  • ReportRunsApiListReportRunsRequest

Properties

ReportRunRetrieveParams limit? offset? status? tilled_account type?

Properties

Readonly ReportRunRetrieveParams

ReportRunRetrieveParams: ReportRunRetrieveParams

Memberof

ReportRunsApiListReportRuns

Optional Readonly limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

ReportRunsApiListReportRuns

Optional Readonly offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

ReportRunsApiListReportRuns

Optional Readonly status

status?: ListReportRunsStatus[]

Only return ReportRuns whose status is included by this array. Examples: `?status=finished` and `?status=finished,queued`.

Memberof

ReportRunsApiListReportRuns

Readonly tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

ReportRunsApiListReportRuns

Optional Readonly type

type?: ListReportRunsType[]

Only return ReportRuns whose type is included by this array. Examples: `?type=payments_summary_1,payouts_summary_2` and `?type=payouts_summary_2`.

Memberof

ReportRunsApiListReportRuns

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc