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

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

@@ -0,0 +1,37 @@
+/**
+ * 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 promotion applied to an item.
+ * @export
+ * @interface Promotion
+ */
+export interface Promotion {
+    /**
+     * The type of promotion.
+     * @type {string}
+     * @memberof Promotion
+     */
+    PromotionType?: string;
+    /**
+     * The seller-specified identifier for the promotion.
+     * @type {string}
+     * @memberof Promotion
+     */
+    PromotionId?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof Promotion
+     */
+    PromotionAmount?: Currency;
+}

package/dist/types/src/api-model/models/removal-shipment-adjustment-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 { RemovalShipmentItemAdjustment } from './removal-shipment-item-adjustment';
+/**
+ * A financial adjustment event for FBA liquidated inventory.  Possible adjustment:  * Positive values - Buyer needs to pay more amount to Amazon. E.g. charge was wrongly calculated 0$ instead of 100$ due to system error.   * Negative Values - Buyer get refund. E.g. Buyer receives less items or damaged items and as part of their adjustment buyer gets refund.
+ * @export
+ * @interface RemovalShipmentAdjustmentEvent
+ */
+export interface RemovalShipmentAdjustmentEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof RemovalShipmentAdjustmentEvent
+     */
+    PostedDate?: string;
+    /**
+     * The unique identifier for the adjustment event.
+     * @type {string}
+     * @memberof RemovalShipmentAdjustmentEvent
+     */
+    AdjustmentEventId?: string;
+    /**
+     * The merchant removal orderId.
+     * @type {string}
+     * @memberof RemovalShipmentAdjustmentEvent
+     */
+    MerchantOrderId?: string;
+    /**
+     * The orderId for shipping inventory.
+     * @type {string}
+     * @memberof RemovalShipmentAdjustmentEvent
+     */
+    OrderId?: string;
+    /**
+     * The type of removal order.  Possible values:  * WHOLESALE_LIQUIDATION.
+     * @type {string}
+     * @memberof RemovalShipmentAdjustmentEvent
+     */
+    TransactionType?: string;
+    /**
+     * A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory.
+     * @type {Array<RemovalShipmentItemAdjustment>}
+     * @memberof RemovalShipmentAdjustmentEvent
+     */
+    RemovalShipmentItemAdjustmentList?: Array<RemovalShipmentItemAdjustment>;
+}

package/dist/types/src/api-model/models/removal-shipment-event.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { RemovalShipmentItem } from './removal-shipment-item';
+/**
+ * A removal shipment event for a removal order.
+ * @export
+ * @interface RemovalShipmentEvent
+ */
+export interface RemovalShipmentEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof RemovalShipmentEvent
+     */
+    PostedDate?: string;
+    /**
+     * The merchant removal orderId.
+     * @type {string}
+     * @memberof RemovalShipmentEvent
+     */
+    MerchantOrderId?: string;
+    /**
+     * The identifier for the removal shipment order.
+     * @type {string}
+     * @memberof RemovalShipmentEvent
+     */
+    OrderId?: string;
+    /**
+     * The type of removal order.  Possible values:  * WHOLESALE_LIQUIDATION
+     * @type {string}
+     * @memberof RemovalShipmentEvent
+     */
+    TransactionType?: string;
+    /**
+     * A list of information about removal shipment items.
+     * @type {Array<RemovalShipmentItem>}
+     * @memberof RemovalShipmentEvent
+     */
+    RemovalShipmentItemList?: Array<RemovalShipmentItem>;
+}

package/dist/types/src/api-model/models/removal-shipment-item-adjustment.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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';
+/**
+ * Item-level information for a removal shipment item adjustment.
+ * @export
+ * @interface RemovalShipmentItemAdjustment
+ */
+export interface RemovalShipmentItemAdjustment {
+    /**
+     * An identifier for an item in a removal shipment.
+     * @type {string}
+     * @memberof RemovalShipmentItemAdjustment
+     */
+    RemovalShipmentItemId?: string;
+    /**
+     * The tax collection model applied to the item.  Possible values:  * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.  * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon.
+     * @type {string}
+     * @memberof RemovalShipmentItemAdjustment
+     */
+    TaxCollectionModel?: string;
+    /**
+     * The Amazon fulfillment network SKU for the item.
+     * @type {string}
+     * @memberof RemovalShipmentItemAdjustment
+     */
+    FulfillmentNetworkSKU?: string;
+    /**
+     * Adjusted quantity of removal shipmentItemAdjustment items.
+     * @type {number}
+     * @memberof RemovalShipmentItemAdjustment
+     */
+    AdjustedQuantity?: number;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RemovalShipmentItemAdjustment
+     */
+    RevenueAdjustment?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RemovalShipmentItemAdjustment
+     */
+    TaxAmountAdjustment?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RemovalShipmentItemAdjustment
+     */
+    TaxWithheldAdjustment?: Currency;
+}

package/dist/types/src/api-model/models/removal-shipment-item.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';
+/**
+ * Item-level information for a removal shipment.
+ * @export
+ * @interface RemovalShipmentItem
+ */
+export interface RemovalShipmentItem {
+    /**
+     * An identifier for an item in a removal shipment.
+     * @type {string}
+     * @memberof RemovalShipmentItem
+     */
+    RemovalShipmentItemId?: string;
+    /**
+     * The tax collection model applied to the item.  Possible values:  * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.  * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon.
+     * @type {string}
+     * @memberof RemovalShipmentItem
+     */
+    TaxCollectionModel?: string;
+    /**
+     * The Amazon fulfillment network SKU for the item.
+     * @type {string}
+     * @memberof RemovalShipmentItem
+     */
+    FulfillmentNetworkSKU?: string;
+    /**
+     * The quantity of the item.
+     * @type {number}
+     * @memberof RemovalShipmentItem
+     */
+    Quantity?: number;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RemovalShipmentItem
+     */
+    Revenue?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RemovalShipmentItem
+     */
+    FeeAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RemovalShipmentItem
+     */
+    TaxAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RemovalShipmentItem
+     */
+    TaxWithheld?: Currency;
+}

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

@@ -0,0 +1,82 @@
+/**
+ * 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 { Currency } from './currency';
+import { FeeComponent } from './fee-component';
+import { TaxWithheldComponent } from './tax-withheld-component';
+/**
+ * An event related to a rental transaction.
+ * @export
+ * @interface RentalTransactionEvent
+ */
+export interface RentalTransactionEvent {
+    /**
+     * An Amazon-defined identifier for an order.
+     * @type {string}
+     * @memberof RentalTransactionEvent
+     */
+    AmazonOrderId?: string;
+    /**
+     * The type of rental event.  Possible values:  * RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item.  * RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period.  * RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item.  * RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item.  * RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon.  * RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge.  * RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item.
+     * @type {string}
+     * @memberof RentalTransactionEvent
+     */
+    RentalEventType?: string;
+    /**
+     * The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events.
+     * @type {number}
+     * @memberof RentalTransactionEvent
+     */
+    ExtensionLength?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RentalTransactionEvent
+     */
+    PostedDate?: string;
+    /**
+     * A list of charge information on the seller\'s account.
+     * @type {Array<ChargeComponent>}
+     * @memberof RentalTransactionEvent
+     */
+    RentalChargeList?: Array<ChargeComponent>;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof RentalTransactionEvent
+     */
+    RentalFeeList?: Array<FeeComponent>;
+    /**
+     * The name of the marketplace.
+     * @type {string}
+     * @memberof RentalTransactionEvent
+     */
+    MarketplaceName?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RentalTransactionEvent
+     */
+    RentalInitialValue?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RentalTransactionEvent
+     */
+    RentalReimbursement?: Currency;
+    /**
+     * A list of information about taxes withheld.
+     * @type {Array<TaxWithheldComponent>}
+     * @memberof RentalTransactionEvent
+     */
+    RentalTaxWithheldList?: Array<TaxWithheldComponent>;
+}

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

@@ -0,0 +1,62 @@
+/**
+ * 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';
+import { TaxWithheldComponent } from './tax-withheld-component';
+/**
+ * A retrocharge or retrocharge reversal.
+ * @export
+ * @interface RetrochargeEvent
+ */
+export interface RetrochargeEvent {
+    /**
+     * The type of event.  Possible values:  * Retrocharge  * RetrochargeReversal
+     * @type {string}
+     * @memberof RetrochargeEvent
+     */
+    RetrochargeEventType?: string;
+    /**
+     * An Amazon-defined identifier for an order.
+     * @type {string}
+     * @memberof RetrochargeEvent
+     */
+    AmazonOrderId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrochargeEvent
+     */
+    PostedDate?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RetrochargeEvent
+     */
+    BaseTax?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RetrochargeEvent
+     */
+    ShippingTax?: Currency;
+    /**
+     * The name of the marketplace where the retrocharge event occurred.
+     * @type {string}
+     * @memberof RetrochargeEvent
+     */
+    MarketplaceName?: string;
+    /**
+     * A list of information about taxes withheld.
+     * @type {Array<TaxWithheldComponent>}
+     * @memberof RetrochargeEvent
+     */
+    RetrochargeTaxWithheldList?: Array<TaxWithheldComponent>;
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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';
+import { SAFETReimbursementItem } from './safetreimbursement-item';
+/**
+ * A SAFE-T claim reimbursement on the seller\'s account.
+ * @export
+ * @interface SAFETReimbursementEvent
+ */
+export interface SAFETReimbursementEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof SAFETReimbursementEvent
+     */
+    PostedDate?: string;
+    /**
+     * A SAFE-T claim identifier.
+     * @type {string}
+     * @memberof SAFETReimbursementEvent
+     */
+    SAFETClaimId?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof SAFETReimbursementEvent
+     */
+    ReimbursedAmount?: Currency;
+    /**
+     * Indicates why the seller was reimbursed.
+     * @type {string}
+     * @memberof SAFETReimbursementEvent
+     */
+    ReasonCode?: string;
+    /**
+     * A list of SAFETReimbursementItems.
+     * @type {Array<SAFETReimbursementItem>}
+     * @memberof SAFETReimbursementEvent
+     */
+    SAFETReimbursementItemList?: Array<SAFETReimbursementItem>;
+}