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

    Interface FinancesApiListFinancialEventGroupsRequest

    Request parameters for listFinancialEventGroups operation in FinancesApi.

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

    Properties

    financialEventGroupStartedAfter? financialEventGroupStartedBefore? maxResultsPerPage? nextToken?

    Properties

    financialEventGroupStartedAfter?: string

    A date that selects financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be more than two minutes before you submit the request.

    financialEventGroupStartedBefore?: string

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

    maxResultsPerPage?: number

    The maximum number of results 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.

    Settings

    Member Visibility

    On This Page

    Properties