@sp-api-sdk/finances-api-v0 1.7.0

package/dist/types/src/api-model/models/imaging-services-fee-event.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FeeComponent } from './fee-component';
+/**
+ * A fee event related to Amazon Imaging services.
+ * @export
+ * @interface ImagingServicesFeeEvent
+ */
+export interface ImagingServicesFeeEvent {
+    /**
+     * The identifier for the imaging services request.
+     * @type {string}
+     * @memberof ImagingServicesFeeEvent
+     */
+    ImagingRequestBillingItemID?: string;
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item for which the imaging service was requested.
+     * @type {string}
+     * @memberof ImagingServicesFeeEvent
+     */
+    ASIN?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ImagingServicesFeeEvent
+     */
+    PostedDate?: string;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ImagingServicesFeeEvent
+     */
+    FeeList?: Array<FeeComponent>;
+}

package/dist/types/src/api-model/models/index.d.ts

@@ -0,0 +1,43 @@
+export * from './adjustment-event';
+export * from './adjustment-item';
+export * from './affordability-expense-event';
+export * from './charge-component';
+export * from './charge-instrument';
+export * from './coupon-payment-event';
+export * from './currency';
+export * from './debt-recovery-event';
+export * from './debt-recovery-item';
+export * from './direct-payment';
+export * from './fbaliquidation-event';
+export * from './fee-component';
+export * from './financial-event-group';
+export * from './financial-events';
+export * from './imaging-services-fee-event';
+export * from './list-financial-event-groups-payload';
+export * from './list-financial-event-groups-response';
+export * from './list-financial-events-payload';
+export * from './list-financial-events-response';
+export * from './loan-servicing-event';
+export * from './model-error';
+export * from './network-commingling-transaction-event';
+export * from './pay-with-amazon-event';
+export * from './product-ads-payment-event';
+export * from './promotion';
+export * from './removal-shipment-adjustment-event';
+export * from './removal-shipment-event';
+export * from './removal-shipment-item';
+export * from './removal-shipment-item-adjustment';
+export * from './rental-transaction-event';
+export * from './retrocharge-event';
+export * from './safetreimbursement-event';
+export * from './safetreimbursement-item';
+export * from './seller-deal-payment-event';
+export * from './seller-review-enrollment-payment-event';
+export * from './service-fee-event';
+export * from './shipment-event';
+export * from './shipment-item';
+export * from './solution-provider-credit-event';
+export * from './tax-withheld-component';
+export * from './tax-withholding-event';
+export * from './tax-withholding-period';
+export * from './trial-shipment-event';

package/dist/types/src/api-model/models/list-financial-event-groups-payload.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FinancialEventGroup } from './financial-event-group';
+/**
+ * The payload for the listFinancialEventGroups operation.
+ * @export
+ * @interface ListFinancialEventGroupsPayload
+ */
+export interface ListFinancialEventGroupsPayload {
+    /**
+     * When present and not empty, pass this string token in the next request to return the next response page.
+     * @type {string}
+     * @memberof ListFinancialEventGroupsPayload
+     */
+    NextToken?: string;
+    /**
+     * A list of financial event group information.
+     * @type {Array<FinancialEventGroup>}
+     * @memberof ListFinancialEventGroupsPayload
+     */
+    FinancialEventGroupList?: Array<FinancialEventGroup>;
+}

package/dist/types/src/api-model/models/list-financial-event-groups-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ListFinancialEventGroupsPayload } from './list-financial-event-groups-payload';
+/**
+ * The response schema for the listFinancialEventGroups operation.
+ * @export
+ * @interface ListFinancialEventGroupsResponse
+ */
+export interface ListFinancialEventGroupsResponse {
+    /**
+     *
+     * @type {ListFinancialEventGroupsPayload}
+     * @memberof ListFinancialEventGroupsResponse
+     */
+    payload?: ListFinancialEventGroupsPayload;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof ListFinancialEventGroupsResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/list-financial-events-payload.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FinancialEvents } from './financial-events';
+/**
+ * The payload for the listFinancialEvents operation.
+ * @export
+ * @interface ListFinancialEventsPayload
+ */
+export interface ListFinancialEventsPayload {
+    /**
+     * When present and not empty, pass this string token in the next request to return the next response page.
+     * @type {string}
+     * @memberof ListFinancialEventsPayload
+     */
+    NextToken?: string;
+    /**
+     *
+     * @type {FinancialEvents}
+     * @memberof ListFinancialEventsPayload
+     */
+    FinancialEvents?: FinancialEvents;
+}

package/dist/types/src/api-model/models/list-financial-events-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ListFinancialEventsPayload } from './list-financial-events-payload';
+/**
+ * The response schema for the listFinancialEvents operation.
+ * @export
+ * @interface ListFinancialEventsResponse
+ */
+export interface ListFinancialEventsResponse {
+    /**
+     *
+     * @type {ListFinancialEventsPayload}
+     * @memberof ListFinancialEventsResponse
+     */
+    payload?: ListFinancialEventsPayload;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof ListFinancialEventsResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/loan-servicing-event.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Currency } from './currency';
+/**
+ * A loan advance, loan payment, or loan refund.
+ * @export
+ * @interface LoanServicingEvent
+ */
+export interface LoanServicingEvent {
+    /**
+     *
+     * @type {Currency}
+     * @memberof LoanServicingEvent
+     */
+    LoanAmount?: Currency;
+    /**
+     * The type of event.  Possible values:  * LoanAdvance  * LoanPayment  * LoanRefund
+     * @type {string}
+     * @memberof LoanServicingEvent
+     */
+    SourceBusinessEventType?: string;
+}

package/dist/types/src/api-model/models/model-error.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Error response returned when the request is unsuccessful.
+ * @export
+ * @interface ModelError
+ */
+export interface ModelError {
+    /**
+     * An error code that identifies the type of error that occurred.
+     * @type {string}
+     * @memberof ModelError
+     */
+    code: string;
+    /**
+     * A message that describes the error condition in a human-readable form.
+     * @type {string}
+     * @memberof ModelError
+     */
+    message: string;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     * @type {string}
+     * @memberof ModelError
+     */
+    details?: string;
+}

package/dist/types/src/api-model/models/network-commingling-transaction-event.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Currency } from './currency';
+/**
+ * A network commingling transaction event.
+ * @export
+ * @interface NetworkComminglingTransactionEvent
+ */
+export interface NetworkComminglingTransactionEvent {
+    /**
+     * The type of network item swap.  Possible values:  * NetCo - A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace.  * ComminglingVAT - A commingling VAT transaction. Available only in the UK, Spain, France, Germany, and Italy marketplaces.
+     * @type {string}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    TransactionType?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    PostedDate?: string;
+    /**
+     * The identifier for the network item swap.
+     * @type {string}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    NetCoTransactionID?: string;
+    /**
+     * The reason for the network item swap.
+     * @type {string}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    SwapReason?: string;
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the swapped item.
+     * @type {string}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    ASIN?: string;
+    /**
+     * The marketplace in which the event took place.
+     * @type {string}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    MarketplaceId?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    TaxExclusiveAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof NetworkComminglingTransactionEvent
+     */
+    TaxAmount?: Currency;
+}

package/dist/types/src/api-model/models/pay-with-amazon-event.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ChargeComponent } from './charge-component';
+import { FeeComponent } from './fee-component';
+/**
+ * An event related to the seller\'s Pay with Amazon account.
+ * @export
+ * @interface PayWithAmazonEvent
+ */
+export interface PayWithAmazonEvent {
+    /**
+     * An order identifier that is specified by the seller.
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    SellerOrderId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    TransactionPostedDate?: string;
+    /**
+     * The type of business object.
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    BusinessObjectType?: string;
+    /**
+     * The sales channel for the transaction.
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    SalesChannel?: string;
+    /**
+     *
+     * @type {ChargeComponent}
+     * @memberof PayWithAmazonEvent
+     */
+    Charge?: ChargeComponent;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof PayWithAmazonEvent
+     */
+    FeeList?: Array<FeeComponent>;
+    /**
+     * The type of payment.  Possible values:  * Sales
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    PaymentAmountType?: string;
+    /**
+     * A short description of this payment event.
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    AmountDescription?: string;
+    /**
+     * The fulfillment channel.  Possible values:  * AFN - Amazon Fulfillment Network (Fulfillment by Amazon)  * MFN - Merchant Fulfillment Network (self-fulfilled)
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    FulfillmentChannel?: string;
+    /**
+     * The store name where the event occurred.
+     * @type {string}
+     * @memberof PayWithAmazonEvent
+     */
+    StoreName?: string;
+}

package/dist/types/src/api-model/models/product-ads-payment-event.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Currency } from './currency';
+/**
+ * A Sponsored Products payment event.
+ * @export
+ * @interface ProductAdsPaymentEvent
+ */
+export interface ProductAdsPaymentEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductAdsPaymentEvent
+     */
+    postedDate?: string;
+    /**
+     * Indicates if the transaction is for a charge or a refund.  Possible values:  * charge - Charge  * refund - Refund
+     * @type {string}
+     * @memberof ProductAdsPaymentEvent
+     */
+    transactionType?: string;
+    /**
+     * Identifier for the invoice that the transaction appears in.
+     * @type {string}
+     * @memberof ProductAdsPaymentEvent
+     */
+    invoiceId?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof ProductAdsPaymentEvent
+     */
+    baseValue?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof ProductAdsPaymentEvent
+     */
+    taxValue?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof ProductAdsPaymentEvent
+     */
+    transactionValue?: Currency;
+}