Interface DefaultApiListFinancialEventGroupsRequest

Request parameters for listFinancialEventGroups operation in DefaultApi.

Export

DefaultApiListFinancialEventGroupsRequest

interface DefaultApiListFinancialEventGroupsRequest {
    financialEventGroupStartedAfter?: string;
    financialEventGroupStartedBefore?: string;
    maxResultsPerPage?: number;
    nextToken?: string;
}

Properties

financialEventGroupStartedAfter? financialEventGroupStartedBefore? maxResultsPerPage? nextToken?

Properties

Optional ReadonlyfinancialEventGroupStartedAfter

financialEventGroupStartedAfter?: string

A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted.

Memberof

DefaultApiListFinancialEventGroups

Optional ReadonlyfinancialEventGroupStartedBefore

financialEventGroupStartedBefore?: string

A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.

Memberof

DefaultApiListFinancialEventGroups

Optional ReadonlymaxResultsPerPage

maxResultsPerPage?: number

The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.

Memberof

DefaultApiListFinancialEventGroups

Optional ReadonlynextToken

nextToken?: string

A string token returned in the response of your previous request.

Memberof

DefaultApiListFinancialEventGroups

Settings

Member Visibility

On This Page

Properties