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

package/dist/types/src/api-model/models/charge-instrument.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 payment instrument.
+ * @export
+ * @interface ChargeInstrument
+ */
+export interface ChargeInstrument {
+    /**
+     * A short description of the charge instrument.
+     * @type {string}
+     * @memberof ChargeInstrument
+     */
+    Description?: string;
+    /**
+     * The account tail (trailing digits) of the charge instrument.
+     * @type {string}
+     * @memberof ChargeInstrument
+     */
+    Tail?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof ChargeInstrument
+     */
+    Amount?: Currency;
+}

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

@@ -0,0 +1,69 @@
+/**
+ * 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';
+/**
+ * An event related to coupon payments.
+ * @export
+ * @interface CouponPaymentEvent
+ */
+export interface CouponPaymentEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CouponPaymentEvent
+     */
+    PostedDate?: string;
+    /**
+     * A coupon identifier.
+     * @type {string}
+     * @memberof CouponPaymentEvent
+     */
+    CouponId?: string;
+    /**
+     * The description provided by the seller when they created the coupon.
+     * @type {string}
+     * @memberof CouponPaymentEvent
+     */
+    SellerCouponDescription?: string;
+    /**
+     * The number of coupon clips or redemptions.
+     * @type {number}
+     * @memberof CouponPaymentEvent
+     */
+    ClipOrRedemptionCount?: number;
+    /**
+     * A payment event identifier.
+     * @type {string}
+     * @memberof CouponPaymentEvent
+     */
+    PaymentEventId?: string;
+    /**
+     *
+     * @type {FeeComponent}
+     * @memberof CouponPaymentEvent
+     */
+    FeeComponent?: FeeComponent;
+    /**
+     *
+     * @type {ChargeComponent}
+     * @memberof CouponPaymentEvent
+     */
+    ChargeComponent?: ChargeComponent;
+    /**
+     *
+     * @type {Currency}
+     * @memberof CouponPaymentEvent
+     */
+    TotalAmount?: Currency;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ */
+/**
+ * A currency type and amount.
+ * @export
+ * @interface Currency
+ */
+export interface Currency {
+    /**
+     * The three-digit currency code in ISO 4217 format.
+     * @type {string}
+     * @memberof Currency
+     */
+    CurrencyCode?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Currency
+     */
+    CurrencyAmount?: number;
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { ChargeInstrument } from './charge-instrument';
+import { Currency } from './currency';
+import { DebtRecoveryItem } from './debt-recovery-item';
+/**
+ * A debt payment or debt adjustment.
+ * @export
+ * @interface DebtRecoveryEvent
+ */
+export interface DebtRecoveryEvent {
+    /**
+     * The debt recovery type.  Possible values:  * DebtPayment  * DebtPaymentFailure  *DebtAdjustment
+     * @type {string}
+     * @memberof DebtRecoveryEvent
+     */
+    DebtRecoveryType?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof DebtRecoveryEvent
+     */
+    RecoveryAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof DebtRecoveryEvent
+     */
+    OverPaymentCredit?: Currency;
+    /**
+     * A list of debt recovery item information.
+     * @type {Array<DebtRecoveryItem>}
+     * @memberof DebtRecoveryEvent
+     */
+    DebtRecoveryItemList?: Array<DebtRecoveryItem>;
+    /**
+     * A list of payment instruments.
+     * @type {Array<ChargeInstrument>}
+     * @memberof DebtRecoveryEvent
+     */
+    ChargeInstrumentList?: Array<ChargeInstrument>;
+}

package/dist/types/src/api-model/models/debt-recovery-item.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 { Currency } from './currency';
+/**
+ * An item of a debt payment or debt adjustment.
+ * @export
+ * @interface DebtRecoveryItem
+ */
+export interface DebtRecoveryItem {
+    /**
+     *
+     * @type {Currency}
+     * @memberof DebtRecoveryItem
+     */
+    RecoveryAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof DebtRecoveryItem
+     */
+    OriginalAmount?: Currency;
+    /**
+     *
+     * @type {string}
+     * @memberof DebtRecoveryItem
+     */
+    GroupBeginDate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DebtRecoveryItem
+     */
+    GroupEndDate?: string;
+}

package/dist/types/src/api-model/models/direct-payment.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 payment made directly to a seller.
+ * @export
+ * @interface DirectPayment
+ */
+export interface DirectPayment {
+    /**
+     * The type of payment.  Possible values:  * StoredValueCardRevenue - The amount that is deducted from the seller\'s account because the seller received money through a stored value card.  * StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a stored value card is refunded.  * PrivateLabelCreditCardRevenue - The amount that is deducted from the seller\'s account because the seller received money through a private label credit card offered by Amazon.  * PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought using a private label credit card offered by Amazon is refunded.  * CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer.  * CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded.
+     * @type {string}
+     * @memberof DirectPayment
+     */
+    DirectPaymentType?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof DirectPayment
+     */
+    DirectPaymentAmount?: Currency;
+}

package/dist/types/src/api-model/models/fbaliquidation-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 { Currency } from './currency';
+/**
+ * A payment event for Fulfillment by Amazon (FBA) inventory liquidation. This event is used only in the US marketplace.
+ * @export
+ * @interface FBALiquidationEvent
+ */
+export interface FBALiquidationEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof FBALiquidationEvent
+     */
+    PostedDate?: string;
+    /**
+     * The identifier for the original removal order.
+     * @type {string}
+     * @memberof FBALiquidationEvent
+     */
+    OriginalRemovalOrderId?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof FBALiquidationEvent
+     */
+    LiquidationProceedsAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof FBALiquidationEvent
+     */
+    LiquidationFeeAmount?: Currency;
+}

package/dist/types/src/api-model/models/fee-component.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 fee associated with the event.
+ * @export
+ * @interface FeeComponent
+ */
+export interface FeeComponent {
+    /**
+     * The type of fee. For more information about Selling on Amazon fees, see [Selling on Amazon Fee Schedule](https://sellercentral.amazon.com/gp/help/200336920) on Seller Central. For more information about Fulfillment by Amazon fees, see [FBA features, services and fees](https://sellercentral.amazon.com/gp/help/201074400) on Seller Central.
+     * @type {string}
+     * @memberof FeeComponent
+     */
+    FeeType?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof FeeComponent
+     */
+    FeeAmount?: Currency;
+}

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

@@ -0,0 +1,85 @@
+/**
+ * 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';
+/**
+ * Information related to a financial event group.
+ * @export
+ * @interface FinancialEventGroup
+ */
+export interface FinancialEventGroup {
+    /**
+     * A unique identifier for the financial event group.
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    FinancialEventGroupId?: string;
+    /**
+     * The processing status of the financial event group indicates whether the balance of the financial event group is settled.  Possible values:  * Open  * Closed
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    ProcessingStatus?: string;
+    /**
+     * The status of the fund transfer.
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    FundTransferStatus?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof FinancialEventGroup
+     */
+    OriginalTotal?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof FinancialEventGroup
+     */
+    ConvertedTotal?: Currency;
+    /**
+     *
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    FundTransferDate?: string;
+    /**
+     * The trace identifier used by sellers to look up transactions externally.
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    TraceId?: string;
+    /**
+     * The account tail of the payment instrument.
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    AccountTail?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof FinancialEventGroup
+     */
+    BeginningBalance?: Currency;
+    /**
+     *
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    FinancialEventGroupStart?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FinancialEventGroup
+     */
+    FinancialEventGroupEnd?: string;
+}

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

@@ -0,0 +1,202 @@
+/**
+ * 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 { AdjustmentEvent } from './adjustment-event';
+import { AffordabilityExpenseEvent } from './affordability-expense-event';
+import { CouponPaymentEvent } from './coupon-payment-event';
+import { DebtRecoveryEvent } from './debt-recovery-event';
+import { FBALiquidationEvent } from './fbaliquidation-event';
+import { ImagingServicesFeeEvent } from './imaging-services-fee-event';
+import { LoanServicingEvent } from './loan-servicing-event';
+import { NetworkComminglingTransactionEvent } from './network-commingling-transaction-event';
+import { PayWithAmazonEvent } from './pay-with-amazon-event';
+import { ProductAdsPaymentEvent } from './product-ads-payment-event';
+import { RemovalShipmentAdjustmentEvent } from './removal-shipment-adjustment-event';
+import { RemovalShipmentEvent } from './removal-shipment-event';
+import { RentalTransactionEvent } from './rental-transaction-event';
+import { RetrochargeEvent } from './retrocharge-event';
+import { SAFETReimbursementEvent } from './safetreimbursement-event';
+import { SellerDealPaymentEvent } from './seller-deal-payment-event';
+import { SellerReviewEnrollmentPaymentEvent } from './seller-review-enrollment-payment-event';
+import { ServiceFeeEvent } from './service-fee-event';
+import { ShipmentEvent } from './shipment-event';
+import { SolutionProviderCreditEvent } from './solution-provider-credit-event';
+import { TaxWithholdingEvent } from './tax-withholding-event';
+import { TrialShipmentEvent } from './trial-shipment-event';
+/**
+ * Contains all information related to a financial event.
+ * @export
+ * @interface FinancialEvents
+ */
+export interface FinancialEvents {
+    /**
+     * A list of shipment event information.
+     * @type {Array<ShipmentEvent>}
+     * @memberof FinancialEvents
+     */
+    ShipmentEventList?: Array<ShipmentEvent>;
+    /**
+     * A list of shipment event information.
+     * @type {Array<ShipmentEvent>}
+     * @memberof FinancialEvents
+     */
+    RefundEventList?: Array<ShipmentEvent>;
+    /**
+     * A list of shipment event information.
+     * @type {Array<ShipmentEvent>}
+     * @memberof FinancialEvents
+     */
+    GuaranteeClaimEventList?: Array<ShipmentEvent>;
+    /**
+     * A list of shipment event information.
+     * @type {Array<ShipmentEvent>}
+     * @memberof FinancialEvents
+     */
+    ChargebackEventList?: Array<ShipmentEvent>;
+    /**
+     * A list of events related to the seller\'s Pay with Amazon account.
+     * @type {Array<PayWithAmazonEvent>}
+     * @memberof FinancialEvents
+     */
+    PayWithAmazonEventList?: Array<PayWithAmazonEvent>;
+    /**
+     * A list of information about solution provider credits.
+     * @type {Array<SolutionProviderCreditEvent>}
+     * @memberof FinancialEvents
+     */
+    ServiceProviderCreditEventList?: Array<SolutionProviderCreditEvent>;
+    /**
+     * A list of information about Retrocharge or RetrochargeReversal events.
+     * @type {Array<RetrochargeEvent>}
+     * @memberof FinancialEvents
+     */
+    RetrochargeEventList?: Array<RetrochargeEvent>;
+    /**
+     * A list of rental transaction event information.
+     * @type {Array<RentalTransactionEvent>}
+     * @memberof FinancialEvents
+     */
+    RentalTransactionEventList?: Array<RentalTransactionEvent>;
+    /**
+     * A list of sponsored products payment events.
+     * @type {Array<ProductAdsPaymentEvent>}
+     * @memberof FinancialEvents
+     */
+    ProductAdsPaymentEventList?: Array<ProductAdsPaymentEvent>;
+    /**
+     * A list of information about service fee events.
+     * @type {Array<ServiceFeeEvent>}
+     * @memberof FinancialEvents
+     */
+    ServiceFeeEventList?: Array<ServiceFeeEvent>;
+    /**
+     * A list of payment events for deal-related fees.
+     * @type {Array<SellerDealPaymentEvent>}
+     * @memberof FinancialEvents
+     */
+    SellerDealPaymentEventList?: Array<SellerDealPaymentEvent>;
+    /**
+     * A list of debt recovery event information.
+     * @type {Array<DebtRecoveryEvent>}
+     * @memberof FinancialEvents
+     */
+    DebtRecoveryEventList?: Array<DebtRecoveryEvent>;
+    /**
+     * A list of loan servicing events.
+     * @type {Array<LoanServicingEvent>}
+     * @memberof FinancialEvents
+     */
+    LoanServicingEventList?: Array<LoanServicingEvent>;
+    /**
+     * A list of adjustment event information for the seller\'s account.
+     * @type {Array<AdjustmentEvent>}
+     * @memberof FinancialEvents
+     */
+    AdjustmentEventList?: Array<AdjustmentEvent>;
+    /**
+     * A list of SAFETReimbursementEvents.
+     * @type {Array<SAFETReimbursementEvent>}
+     * @memberof FinancialEvents
+     */
+    SAFETReimbursementEventList?: Array<SAFETReimbursementEvent>;
+    /**
+     * A list of information about fee events for the Early Reviewer Program.
+     * @type {Array<SellerReviewEnrollmentPaymentEvent>}
+     * @memberof FinancialEvents
+     */
+    SellerReviewEnrollmentPaymentEventList?: Array<SellerReviewEnrollmentPaymentEvent>;
+    /**
+     * A list of FBA inventory liquidation payment events.
+     * @type {Array<FBALiquidationEvent>}
+     * @memberof FinancialEvents
+     */
+    FBALiquidationEventList?: Array<FBALiquidationEvent>;
+    /**
+     * A list of coupon payment event information.
+     * @type {Array<CouponPaymentEvent>}
+     * @memberof FinancialEvents
+     */
+    CouponPaymentEventList?: Array<CouponPaymentEvent>;
+    /**
+     * A list of fee events related to Amazon Imaging services.
+     * @type {Array<ImagingServicesFeeEvent>}
+     * @memberof FinancialEvents
+     */
+    ImagingServicesFeeEventList?: Array<ImagingServicesFeeEvent>;
+    /**
+     * A list of network commingling transaction events.
+     * @type {Array<NetworkComminglingTransactionEvent>}
+     * @memberof FinancialEvents
+     */
+    NetworkComminglingTransactionEventList?: Array<NetworkComminglingTransactionEvent>;
+    /**
+     * A list of expense information related to an affordability promotion.
+     * @type {Array<AffordabilityExpenseEvent>}
+     * @memberof FinancialEvents
+     */
+    AffordabilityExpenseEventList?: Array<AffordabilityExpenseEvent>;
+    /**
+     * A list of expense information related to an affordability promotion.
+     * @type {Array<AffordabilityExpenseEvent>}
+     * @memberof FinancialEvents
+     */
+    AffordabilityExpenseReversalEventList?: Array<AffordabilityExpenseEvent>;
+    /**
+     * A list of information about trial shipment financial events.
+     * @type {Array<TrialShipmentEvent>}
+     * @memberof FinancialEvents
+     */
+    TrialShipmentEventList?: Array<TrialShipmentEvent>;
+    /**
+     * A list of information about shipment settle financial events.
+     * @type {Array<ShipmentEvent>}
+     * @memberof FinancialEvents
+     */
+    ShipmentSettleEventList?: Array<ShipmentEvent>;
+    /**
+     * List of TaxWithholding events.
+     * @type {Array<TaxWithholdingEvent>}
+     * @memberof FinancialEvents
+     */
+    TaxWithholdingEventList?: Array<TaxWithholdingEvent>;
+    /**
+     * A list of removal shipment event information.
+     * @type {Array<RemovalShipmentEvent>}
+     * @memberof FinancialEvents
+     */
+    RemovalShipmentEventList?: Array<RemovalShipmentEvent>;
+    /**
+     * A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.
+     * @type {Array<RemovalShipmentAdjustmentEvent>}
+     * @memberof FinancialEvents
+     */
+    RemovalShipmentAdjustmentEventList?: Array<RemovalShipmentAdjustmentEvent>;
+}