Function FinancesApiFp

Returns {
    listFinancialEventGroups(
        maxResultsPerPage?: number,
        financialEventGroupStartedBefore?: string,
        financialEventGroupStartedAfter?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventGroupsResponse>,
    >;
    listFinancialEvents(
        maxResultsPerPage?: number,
        postedAfter?: string,
        postedBefore?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >;
    listFinancialEventsByGroupId(
        eventGroupId: string,
        maxResultsPerPage?: number,
        postedAfter?: string,
        postedBefore?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >;
    listFinancialEventsByOrderId(
        orderId: string,
        maxResultsPerPage?: number,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >;
}

• listFinancialEventGroups: function

  • listFinancialEventGroups(
        maxResultsPerPage?: number,
        financialEventGroupStartedBefore?: string,
        financialEventGroupStartedAfter?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventGroupsResponse>,
    >

    Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • OptionalmaxResultsPerPage: number

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

    • OptionalfinancialEventGroupStartedBefore: 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.

    • OptionalfinancialEventGroupStartedAfter: 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.

    • OptionalnextToken: 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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventGroupsResponse>,
    >

    Throws

• listFinancialEvents: function

  • listFinancialEvents(
        maxResultsPerPage?: number,
        postedAfter?: string,
        postedBefore?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >

    Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. Note: in ListFinancialEvents, deferred events don't show up in responses until they are released. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • OptionalmaxResultsPerPage: 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`.

    • OptionalpostedAfter: 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.

    • OptionalpostedBefore: 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.

    • OptionalnextToken: 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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >

    Throws

• listFinancialEventsByGroupId: function

  • listFinancialEventsByGroupId(
        eventGroupId: string,
        maxResultsPerPage?: number,
        postedAfter?: string,
        postedBefore?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >

    Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. Note: This operation only retrieves a group's data for the past two years. A request for data spanning more than two years produces an empty response. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • eventGroupId: string

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

    • OptionalmaxResultsPerPage: 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`.

    • OptionalpostedAfter: 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.

    • OptionalpostedBefore: 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.

    • OptionalnextToken: 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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >

    Throws

• listFinancialEventsByOrderId: function

  • listFinancialEventsByOrderId(
        orderId: string,
        maxResultsPerPage?: number,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >

    Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • orderId: string

      An Amazon-defined order identifier, in 3-7-7 format.

    • OptionalmaxResultsPerPage: 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`.

    • OptionalnextToken: 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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListFinancialEventsResponse>,
    >

    Throws