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

    Interface FinancesApiListFinancialEventsByGroupIdRequest

    Request parameters for listFinancialEventsByGroupId operation in FinancesApi.

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

    Properties

    eventGroupId: string

    The identifier of the financial event group to which the events belong.

    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'.

    nextToken?: string

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

    postedAfter?: string

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

    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.