Function FinanceRemittanceApiFp

Returns {
    getRemittance(
        uniquePaymentId: string,
        marketplaceId: string,
        nextTokenForLineItems?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRemittanceResponse>,
    >;
    getRemittanceHeaders(
        marketplaceId: string,
        startDate?: string,
        endDate?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRemittancesResponse>,
    >;
}

• getRemittance: function

  • getRemittance(
        uniquePaymentId: string,
        marketplaceId: string,
        nextTokenForLineItems?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRemittanceResponse>,
    >

    Returns detailed line items for a specific remittance. Results are paginated.

    Parameters

    • uniquePaymentId: string

      The unique identifier for the payment.

    • marketplaceId: string

      The `marketplaceId` is a globally unique identifier used to specify which Amazon store a request is targeting. For more information, refer to Store Identifiers.

    • OptionalnextTokenForLineItems: string

      A token to fetch the next page of results. Use the value returned in the previous response.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getRemittanceHeaders: function

  • getRemittanceHeaders(
        marketplaceId: string,
        startDate?: string,
        endDate?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRemittancesResponse>,
    >

    Returns a list of remittance summaries for the specified Amazon store, filtered by date range. Results are paginated.

    Parameters

    • marketplaceId: string

      The `marketplaceId` is a globally unique identifier used to specify which Amazon store a request is targeting. For more information, refer to Store Identifiers.

    • OptionalstartDate: string

      The earliest payment date for remittances to include in the response. Dates are in ISO 8601 date-time format. The default is 30 days prior to the time of the request. The minimum start date is one year ago from the current date.

    • OptionalendDate: string

      The latest payment date for remittances to include in the response. Dates are in ISO 8601 date-time format. The default is the current date-time. The maximum date range between `startDate` and `endDate` is 90 days.

    • OptionalnextToken: string

      A token to fetch the next page of results. Use the value returned in the previous response.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws