Function FinancesApiFp

Returns {
    listBalances(
        marketplaceIds?: string[],
        balanceType?: string,
        accountType?: string,
        asOfDate?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListBalancesResponse>,
    >;
    listSummary(
        marketplaceIds?: string[],
        accountType?: string,
        relatedIdentifierName?: string,
        relatedIdentifierValue?: string,
        periodStart?: string,
        periodEnd?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SummaryResponse>,
    >;
    listTransactions(
        postedAfter?: string,
        postedBefore?: string,
        marketplaceId?: string,
        transactionStatus?: string,
        relatedIdentifierName?: string,
        relatedIdentifierValue?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListTransactionsResponse>,
    >;
}

• listBalances: function

  • listBalances(
        marketplaceIds?: string[],
        balanceType?: string,
        accountType?: string,
        asOfDate?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListBalancesResponse>,
    >

    Retrieve a balance. This balance can be a past balances at a specified date, or a current balance. Sub-balances are listed by account type and marketplace. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • OptionalmarketplaceIds: string[]

      The marketplaces from which to retrieve balances. If omitted, balances from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to Marketplace IDs.

    • OptionalbalanceType: string

      The type of balance to include in the response. If omitted, all balance types may be included in the response. Possible values: `AVAILABLE`, `RESERVED`, `TOTAL`, `DEFERRED`, `ACCOUNT_LEVEL_RESERVE`

    • OptionalaccountType: string

      The type of account to include in the response.

    • OptionalasOfDate: string

      The date from which you want to retrieve balances. If provided, the response includes historical balances at the specified date. The value must be in ISO 8601 date format. If omitted, the point in time balance is provided.

    • OptionalnextToken: string

      A token that you use to retrieve subsequent pages of results. When there are more than 500 results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• listSummary: function

  • listSummary(
        marketplaceIds?: string[],
        accountType?: string,
        relatedIdentifierName?: string,
        relatedIdentifierValue?: string,
        periodStart?: string,
        periodEnd?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SummaryResponse>,
    >

    Retrieve the financial summary for the specified time period or settlement period. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • OptionalmarketplaceIds: string[]

      The marketplaces from which to retrieve summaries. If omitted, summaries from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to Marketplace IDs.

    • OptionalaccountType: string

      The type of account to include in the response.

    • OptionalrelatedIdentifierName: string

      The name of the `relatedIdentifier`. The only possible value is `SETTLEMENT_ID`, the settlement ID associated with the summary.

    • OptionalrelatedIdentifierValue: string

      The value of the `relatedIdentifier`.

    • OptionalperiodStart: string

      The start of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or after the specified date. The value must be formatted in ISO 8601 date format.

    • OptionalperiodEnd: string

      The end of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or before the specified date. The value must be formatted in ISO 8601 date format.

    • OptionalnextToken: string

      A token that you use to retrieve subsequent pages of results. When there are more results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• listTransactions: function

  • listTransactions(
        postedAfter?: string,
        postedBefore?: string,
        marketplaceId?: string,
        transactionStatus?: string,
        relatedIdentifierName?: string,
        relatedIdentifierValue?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListTransactionsResponse>,
    >

    Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. Note: If you want to retrieve MFN orders in the US store, do not supply the marketplaceId parameter. Usage plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • OptionalpostedAfter: string

      The response includes financial events posted on or after 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. This field is required if you do not specify a related identifier.

    • 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. Default: Two minutes before the time of the request.

    • OptionalmarketplaceId: string

      The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for a marketplace, refer to Marketplace IDs.

    • OptionaltransactionStatus: string

      The status of the transaction. Possible values: * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.

    • OptionalrelatedIdentifierName: string

      The name of the `relatedIdentifier`. Possible values: * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. Note: `FINANCIAL_EVENT_GROUP_ID` and `ORDER_ID` are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes.

    • OptionalrelatedIdentifierValue: string

      The value of the `relatedIdentifier`.

    • 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<ListTransactionsResponse>,
    >

    Throws