Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Interface FinancesApiListBalancesRequest

    Request parameters for listBalances operation in FinancesApi.

    interface FinancesApiListBalancesRequest {
        accountType?: string;
        asOfDate?: string;
        balanceType?: string;
        marketplaceIds?: string[];
        nextToken?: string;
    }
    Index
    accountType? asOfDate? balanceType? marketplaceIds? nextToken?
    accountType?: string

    The type of account to include in the response.

    asOfDate?: 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.

    balanceType?: 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`

    marketplaceIds?: 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.

    nextToken?: 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.

    Settings
    Member Visibility

    On This Page
    Properties