Class FinanceRemittanceApi

FinanceRemittanceApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- FinanceRemittanceApi
  - FinanceRemittanceApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getRemittance getRemittanceHeaders

Constructors

constructor

new FinanceRemittanceApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): FinanceRemittanceApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns FinanceRemittanceApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getRemittance

getRemittance(
requestParameters: FinanceRemittanceApiGetRemittanceRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetRemittanceResponse, any, {}, any>>
Returns detailed line items for a specific remittance. Results are paginated.
Parameters
- requestParameters: FinanceRemittanceApiGetRemittanceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetRemittanceResponse, any, {}, any>>

Throws
- Defined in api-model/api/finance-remittance-api.ts:254

getRemittanceHeaders

getRemittanceHeaders(
requestParameters: FinanceRemittanceApiGetRemittanceHeadersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetRemittancesResponse, any, {}, any>>
Returns a list of remittance summaries for the specified Amazon store, filtered by date range. Results are paginated.
Parameters
- requestParameters: FinanceRemittanceApiGetRemittanceHeadersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetRemittancesResponse, any, {}, any>>

Throws
- Defined in api-model/api/finance-remittance-api.ts:264