Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface FinancesApiListFinancialEventsRequest

    Request parameters for listFinancialEvents operation in FinancesApi.

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

    Properties

    maxResultsPerPage?: number

    The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.

    nextToken?: string

    The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

    postedAfter?: string

    The response includes financial events posted after (or on) this date. This date must be in ISO 8601 date-time format. The date-time must be more than two minutes before the time of the request.

    postedBefore?: string

    The response includes financial events posted before (but not on) this date. This date must be in ISO 8601 date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. Default: Two minutes before the time of the request.