@sp-api-sdk/finances-api-2024-06-19 3.3.4 → 4.0.0

package/dist/index.d.cts

@@ -0,0 +1,791 @@
+import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import * as axios from 'axios';
+import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface AWSv4Configuration {
+    options?: {
+        region?: string;
+        service?: string;
+    };
+    credentials?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        sessionToken?: string;
+    };
+}
+interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
+     * @memberof Configuration
+     */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
+    basePath?: string;
+    /**
+     * override server index
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Additional information related to Amazon Pay.
+ */
+interface AmazonPayContext {
+    /**
+     * The name of the store that is related to the transaction.
+     */
+    'storeName'?: string;
+    /**
+     * The transaction\'s order type.
+     */
+    'orderType'?: string;
+    /**
+     * Channel details of related transaction.
+     */
+    'channel'?: string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A currency type and amount.
+ */
+interface Currency {
+    /**
+     * The three-digit currency code in ISO 4217 format.
+     */
+    'currencyCode'?: string;
+    /**
+     * A signed decimal number.
+     */
+    'currencyAmount'?: number;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Details about the movement of money in the financial transaction. Breakdowns are further categorized into breakdown types, breakdown amounts, and further breakdowns.
+ */
+interface Breakdown {
+    /**
+     * The type of charge.
+     */
+    'breakdownType'?: string;
+    'breakdownAmount'?: Currency;
+    /**
+     * A list of breakdowns that detail how the total amount is calculated for the transaction.
+     */
+    'breakdowns'?: Array<Breakdown>;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Information about the line of business associated with a transaction.
+ */
+interface BusinessContext {
+    /**
+     * The store name associated with the transaction.
+     */
+    'storeName'?: BusinessContextStoreNameEnum;
+}
+declare const BusinessContextStoreNameEnum: {
+    readonly AmazonHaul: "AMAZON_HAUL";
+};
+type BusinessContextStoreNameEnum = typeof BusinessContextStoreNameEnum[keyof typeof BusinessContextStoreNameEnum];
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface ContextAllOf {
+    'contextType': string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Additional information related to deferred transactions.
+ */
+interface DeferredContext {
+    /**
+     * The deferral policy applied to the transaction.  **Examples:** `B2B` (invoiced orders), `DD7` (delivery date policy)
+     */
+    'deferralReason'?: string;
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     */
+    'maturityDate'?: string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Additional information related to payments-related transactions.
+ */
+interface PaymentsContext {
+    /**
+     * The type of payment.
+     */
+    'paymentType'?: string;
+    /**
+     * The method of payment.
+     */
+    'paymentMethod'?: string;
+    /**
+     * The reference number of the payment.
+     */
+    'paymentReference'?: string;
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     */
+    'paymentDate'?: string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Additional information related to the product.
+ */
+interface ProductContext {
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item.
+     */
+    'asin'?: string;
+    /**
+     * The Stock Keeping Unit (SKU) of the item.
+     */
+    'sku'?: string;
+    /**
+     * The quantity of the item shipped.
+     */
+    'quantityShipped'?: number;
+    /**
+     * The fulfillment network of the item.
+     */
+    'fulfillmentNetwork'?: string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Additional information that is related to the time range of the transaction.
+ */
+interface TimeRangeContext {
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     */
+    'startTime'?: string;
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     */
+    'endTime'?: string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type Context
+ * Additional Information about the item.
+ */
+type Context = AmazonPayContext & BusinessContext & ContextAllOf & DeferredContext & PaymentsContext & ProductContext & TimeRangeContext;
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A list of error responses returned when a request is unsuccessful.
+ */
+interface ErrorList {
+    /**
+     * The error responses that are returned when the request is unsuccessful.
+     */
+    'errors': Array<Error>;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Related business identifiers of the item.
+ */
+interface ItemRelatedIdentifier {
+    /**
+     * Enumerated set of related item identifier names for the item.
+     */
+    'itemRelatedIdentifierName'?: ItemRelatedIdentifierItemRelatedIdentifierNameEnum;
+    /**
+     * Corresponding value to `ItemRelatedIdentifierName`.
+     */
+    'itemRelatedIdentifierValue'?: string;
+}
+declare const ItemRelatedIdentifierItemRelatedIdentifierNameEnum: {
+    readonly OrderAdjustmentItemId: "ORDER_ADJUSTMENT_ITEM_ID";
+    readonly CouponId: "COUPON_ID";
+    readonly RemovalShipmentItemId: "REMOVAL_SHIPMENT_ITEM_ID";
+    readonly TransactionId: "TRANSACTION_ID";
+};
+type ItemRelatedIdentifierItemRelatedIdentifierNameEnum = typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum[keyof typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum];
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Additional information about the items in a transaction.
+ */
+interface Item {
+    /**
+     * A description of the items in a transaction.
+     */
+    'description'?: string;
+    /**
+     * Related business identifiers of the item in the transaction.
+     */
+    'relatedIdentifiers'?: Array<ItemRelatedIdentifier>;
+    'totalAmount'?: Currency;
+    /**
+     * A list of breakdowns that detail how the total amount is calculated for the transaction.
+     */
+    'breakdowns'?: Array<Breakdown>;
+    /**
+     * A list of additional information about the item.
+     */
+    'contexts'?: Array<Context>;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Information about the marketplace where the transaction occurred.
+ */
+interface MarketplaceDetails {
+    /**
+     * The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     */
+    'marketplaceId'?: string;
+    /**
+     * The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`
+     */
+    'marketplaceName'?: string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Related business identifier of the transaction.
+ */
+interface RelatedIdentifier {
+    /**
+     * An enumerated set of related business identifier names.
+     */
+    'relatedIdentifierName'?: RelatedIdentifierRelatedIdentifierNameEnum;
+    /**
+     * Corresponding value of `RelatedIdentifierName`.
+     */
+    'relatedIdentifierValue'?: string;
+}
+declare const RelatedIdentifierRelatedIdentifierNameEnum: {
+    readonly OrderId: "ORDER_ID";
+    readonly ShipmentId: "SHIPMENT_ID";
+    readonly FinancialEventGroupId: "FINANCIAL_EVENT_GROUP_ID";
+    readonly RefundId: "REFUND_ID";
+    readonly InvoiceId: "INVOICE_ID";
+    readonly DisbursementId: "DISBURSEMENT_ID";
+    readonly TransferId: "TRANSFER_ID";
+    readonly DeferredTransactionId: "DEFERRED_TRANSACTION_ID";
+    readonly ReleaseTransactionId: "RELEASE_TRANSACTION_ID";
+    readonly SettlementId: "SETTLEMENT_ID";
+};
+type RelatedIdentifierRelatedIdentifierNameEnum = typeof RelatedIdentifierRelatedIdentifierNameEnum[keyof typeof RelatedIdentifierRelatedIdentifierNameEnum];
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Metadata that describes the seller.
+ */
+interface SellingPartnerMetadata {
+    /**
+     * A unique seller identifier.
+     */
+    'sellingPartnerId'?: string;
+    /**
+     * The type of account in the transaction.
+     */
+    'accountType'?: string;
+    /**
+     * The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     */
+    'marketplaceId'?: string;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * All the information related to a transaction.
+ */
+interface Transaction {
+    'sellingPartnerMetadata'?: SellingPartnerMetadata;
+    /**
+     * Related business identifiers of the transaction.
+     */
+    'relatedIdentifiers'?: Array<RelatedIdentifier>;
+    /**
+     * The type of transaction.  **Possible value:** `Shipment`
+     */
+    'transactionType'?: string;
+    /**
+     * The unique identifier of the transaction.
+     */
+    'transactionId'?: 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.
+     */
+    'transactionStatus'?: string;
+    /**
+     * Describes the reasons for the transaction.  **Example:** \'Order Payment\', \'Refund Order\'
+     */
+    'description'?: string;
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     */
+    'postedDate'?: string;
+    'totalAmount'?: Currency;
+    'marketplaceDetails'?: MarketplaceDetails;
+    /**
+     * A list of items in the transaction.
+     */
+    'items'?: Array<Item>;
+    /**
+     * A list of additional information about the item.
+     */
+    'contexts'?: Array<Context>;
+    /**
+     * A list of breakdowns that detail how the total amount is calculated for the transaction.
+     */
+    'breakdowns'?: Array<Breakdown>;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The payload for the `listTransactions` operation.
+ */
+interface TransactionsPayload {
+    /**
+     * 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.
+     */
+    'nextToken'?: string;
+    /**
+     * A list of transactions within the specified time period.
+     */
+    'transactions'?: Array<Transaction>;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The response schema for the `listTransactions` operation.
+ */
+interface ListTransactionsResponse {
+    'payload'?: TransactionsPayload;
+}
+
+/**
+ * The Selling Partner API for Finances
+ * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
+ *
+ * The version of the OpenAPI document: 2024-06-19
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * An error response returned when the request is unsuccessful.
+ */
+interface ModelError {
+    /**
+     * An error code that identifies the type of error that occurred.
+     */
+    'code': string;
+    /**
+     * A message that describes the error condition.
+     */
+    'message': string;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     */
+    'details'?: string;
+}
+
+/**
+ * FinancesApi - axios parameter creator
+ */
+declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours.  **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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
+     * @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/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.
+     * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.  The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty.  **Default:** Two minutes before the time of the request.
+     * @param {string} [marketplaceId] 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 your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {string} [transactionStatus] The status of the transaction.  **Possible values:**  * &#x60;DEFERRED&#x60;: the transaction is currently deferred. * &#x60;RELEASED&#x60;: the transaction is currently released. * &#x60;DEFERRED_RELEASED&#x60;: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to &#x60;DEFERRED_RELEASED&#x60; when the transaction is released.
+     * @param {string} [relatedIdentifierName] The name of the &#x60;relatedIdentifier&#x60;.  **Possible values:**  * &#x60;FINANCIAL_EVENT_GROUP_ID&#x60;: the financial event group ID associated with the transaction.  * &#x60;ORDER_ID&#x60;: the order ID associated with the transaction.    **Note:**   FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only &#x60;relatedIdentifier&#x60; with filtering capabilities at the moment. While other &#x60;relatedIdentifier&#x60; values will be included in the response when available, they cannot be used for filtering purposes.
+     * @param {string} [relatedIdentifierValue] The value of the &#x60;relatedIdentifier&#x60;.
+     * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; 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 &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTransactions: (postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FinancesApi - functional programming interface
+ */
+declare const FinancesApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours.  **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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
+     * @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/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.
+     * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.  The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty.  **Default:** Two minutes before the time of the request.
+     * @param {string} [marketplaceId] 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 your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {string} [transactionStatus] The status of the transaction.  **Possible values:**  * &#x60;DEFERRED&#x60;: the transaction is currently deferred. * &#x60;RELEASED&#x60;: the transaction is currently released. * &#x60;DEFERRED_RELEASED&#x60;: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to &#x60;DEFERRED_RELEASED&#x60; when the transaction is released.
+     * @param {string} [relatedIdentifierName] The name of the &#x60;relatedIdentifier&#x60;.  **Possible values:**  * &#x60;FINANCIAL_EVENT_GROUP_ID&#x60;: the financial event group ID associated with the transaction.  * &#x60;ORDER_ID&#x60;: the order ID associated with the transaction.    **Note:**   FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only &#x60;relatedIdentifier&#x60; with filtering capabilities at the moment. While other &#x60;relatedIdentifier&#x60; values will be included in the response when available, they cannot be used for filtering purposes.
+     * @param {string} [relatedIdentifierValue] The value of the &#x60;relatedIdentifier&#x60;.
+     * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; 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 &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTransactions(postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
+};
+/**
+ * FinancesApi - factory interface
+ */
+declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours.  **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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
+     * @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactionsResponse>;
+};
+/**
+ * Request parameters for listTransactions operation in FinancesApi.
+ */
+interface FinancesApiListTransactionsRequest {
+    /**
+     * The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/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.
+     */
+    readonly postedAfter?: string;
+    /**
+     * The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.  The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty.  **Default:** Two minutes before the time of the request.
+     */
+    readonly postedBefore?: 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 your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     */
+    readonly marketplaceId?: string;
+    /**
+     * The status of the transaction.  **Possible values:**  * &#x60;DEFERRED&#x60;: the transaction is currently deferred. * &#x60;RELEASED&#x60;: the transaction is currently released. * &#x60;DEFERRED_RELEASED&#x60;: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to &#x60;DEFERRED_RELEASED&#x60; when the transaction is released.
+     */
+    readonly transactionStatus?: string;
+    /**
+     * The name of the &#x60;relatedIdentifier&#x60;.  **Possible values:**  * &#x60;FINANCIAL_EVENT_GROUP_ID&#x60;: the financial event group ID associated with the transaction.  * &#x60;ORDER_ID&#x60;: the order ID associated with the transaction.    **Note:**   FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only &#x60;relatedIdentifier&#x60; with filtering capabilities at the moment. While other &#x60;relatedIdentifier&#x60; values will be included in the response when available, they cannot be used for filtering purposes.
+     */
+    readonly relatedIdentifierName?: string;
+    /**
+     * The value of the &#x60;relatedIdentifier&#x60;.
+     */
+    readonly relatedIdentifierValue?: string;
+    /**
+     * The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; 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 &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     */
+    readonly nextToken?: string;
+}
+/**
+ * FinancesApi - object-oriented interface
+ */
+declare class FinancesApi extends BaseAPI {
+    /**
+     * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours.  **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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
+     * @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ListTransactionsResponse, any, {}>>;
+}
+
+declare const clientRateLimits: RateLimit[];
+declare class FinancesApiClient extends FinancesApi {
+    constructor(configuration: ClientConfiguration);
+}
+
+export { type AmazonPayContext, type Breakdown, type BusinessContext, BusinessContextStoreNameEnum, type Context, type ContextAllOf, type Currency, type DeferredContext, type ErrorList, FinancesApi, FinancesApiAxiosParamCreator, FinancesApiClient, FinancesApiFactory, FinancesApiFp, type FinancesApiListTransactionsRequest, type Item, type ItemRelatedIdentifier, ItemRelatedIdentifierItemRelatedIdentifierNameEnum, type ListTransactionsResponse, type MarketplaceDetails, type ModelError, type PaymentsContext, type ProductContext, type RelatedIdentifier, RelatedIdentifierRelatedIdentifierNameEnum, type SellingPartnerMetadata, type TimeRangeContext, type Transaction, type TransactionsPayload, clientRateLimits };