Interface DefaultApiListFinancialEventsRequest

Request parameters for listFinancialEvents operation in DefaultApi.

Export

DefaultApiListFinancialEventsRequest

interface DefaultApiListFinancialEventsRequest {
    maxResultsPerPage?: number;
    nextToken?: string;
    postedAfter?: string;
    postedBefore?: string;
}

Properties

maxResultsPerPage? nextToken? postedAfter? postedBefore?

Properties

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

DefaultApiListFinancialEvents

Optional ReadonlynextToken

nextToken?: string

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

Memberof

DefaultApiListFinancialEvents

Optional ReadonlypostedAfter

postedAfter?: string

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

Memberof

DefaultApiListFinancialEvents

Optional ReadonlypostedBefore

postedBefore?: string

A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.

Memberof

DefaultApiListFinancialEvents

Settings

Member Visibility

On This Page

Properties