@scaleleap/selling-partner-api-sdk
Version:
📦 A fully typed TypeScript and Node.js SDK library for Amazon Selling Partner API
1,566 lines • 103 kB
TypeScript
/**
* 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 { Configuration } from './configuration';
import { AxiosPromise, AxiosInstance } from 'axios';
import { RequestArgs, BaseAPI } from './base';
/**
* An event related to an Adhoc Disbursement.
* @export
* @interface AdhocDisbursementEvent
*/
export interface AdhocDisbursementEvent {
/**
* Indicates the type of transaction. Example: \"Disbursed to Amazon Gift Card balance\"
* @type {string}
* @memberof AdhocDisbursementEvent
*/
TransactionType?: string;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof AdhocDisbursementEvent
*/
PostedDate?: string;
/**
* The identifier for the transaction.
* @type {string}
* @memberof AdhocDisbursementEvent
*/
TransactionId?: string;
/**
*
* @type {Currency}
* @memberof AdhocDisbursementEvent
*/
TransactionAmount?: Currency;
}
/**
* An adjustment to the seller\'s account.
* @export
* @interface AdjustmentEvent
*/
export interface AdjustmentEvent {
/**
* The type of adjustment. Possible values: * FBAInventoryReimbursement - An FBA inventory reimbursement to a seller\'s account. This occurs if a seller\'s inventory is damaged. * ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller\'s account is held back. * PostageBilling - The amount paid by a seller for shipping labels. * PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded. * LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller\'s account for a package that we lost or damaged. * CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller\'s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. * ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller\'s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. * SellerRewards - An award credited to a seller\'s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace.
* @type {string}
* @memberof AdjustmentEvent
*/
AdjustmentType?: string;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof AdjustmentEvent
*/
PostedDate?: string;
/**
*
* @type {Currency}
* @memberof AdjustmentEvent
*/
AdjustmentAmount?: Currency;
/**
* A list of information about items in an adjustment to the seller\'s account.
* @type {Array<AdjustmentItem>}
* @memberof AdjustmentEvent
*/
AdjustmentItemList?: Array<AdjustmentItem>;
}
/**
* An item in an adjustment to the seller\'s account.
* @export
* @interface AdjustmentItem
*/
export interface AdjustmentItem {
/**
* Represents the number of units in the seller\'s inventory when the AdustmentType is FBAInventoryReimbursement.
* @type {string}
* @memberof AdjustmentItem
*/
Quantity?: string;
/**
*
* @type {Currency}
* @memberof AdjustmentItem
*/
PerUnitAmount?: Currency;
/**
*
* @type {Currency}
* @memberof AdjustmentItem
*/
TotalAmount?: Currency;
/**
* The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
* @type {string}
* @memberof AdjustmentItem
*/
SellerSKU?: string;
/**
* A unique identifier assigned to products stored in and fulfilled from a fulfillment center.
* @type {string}
* @memberof AdjustmentItem
*/
FnSKU?: string;
/**
* A short description of the item.
* @type {string}
* @memberof AdjustmentItem
*/
ProductDescription?: string;
/**
* The Amazon Standard Identification Number (ASIN) of the item.
* @type {string}
* @memberof AdjustmentItem
*/
ASIN?: string;
/**
* The transaction number that is related to the adjustment.
* @type {string}
* @memberof AdjustmentItem
*/
TransactionNumber?: string;
}
/**
* An expense related to an affordability promotion.
* @export
* @interface AffordabilityExpenseEvent
*/
export interface AffordabilityExpenseEvent {
/**
* An Amazon-defined identifier for an order.
* @type {string}
* @memberof AffordabilityExpenseEvent
*/
AmazonOrderId?: string;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof AffordabilityExpenseEvent
*/
PostedDate?: string;
/**
* An encrypted, Amazon-defined marketplace identifier.
* @type {string}
* @memberof AffordabilityExpenseEvent
*/
MarketplaceId?: string;
/**
* Indicates the type of transaction. Possible values: * Charge - For an affordability promotion expense. * Refund - For an affordability promotion expense reversal.
* @type {string}
* @memberof AffordabilityExpenseEvent
*/
TransactionType?: string;
/**
*
* @type {Currency}
* @memberof AffordabilityExpenseEvent
*/
BaseExpense?: Currency;
/**
*
* @type {Currency}
* @memberof AffordabilityExpenseEvent
*/
TaxTypeCGST: Currency;
/**
*
* @type {Currency}
* @memberof AffordabilityExpenseEvent
*/
TaxTypeSGST: Currency;
/**
*
* @type {Currency}
* @memberof AffordabilityExpenseEvent
*/
TaxTypeIGST: Currency;
/**
*
* @type {Currency}
* @memberof AffordabilityExpenseEvent
*/
TotalExpense?: Currency;
}
/**
* An event related to a capacity reservation billing charge.
* @export
* @interface CapacityReservationBillingEvent
*/
export interface CapacityReservationBillingEvent {
/**
* Indicates the type of transaction. For example, FBA Inventory Fee
* @type {string}
* @memberof CapacityReservationBillingEvent
*/
TransactionType?: string;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof CapacityReservationBillingEvent
*/
PostedDate?: string;
/**
* A short description of the capacity reservation billing event.
* @type {string}
* @memberof CapacityReservationBillingEvent
*/
Description?: string;
/**
*
* @type {Currency}
* @memberof CapacityReservationBillingEvent
*/
TransactionAmount?: Currency;
}
/**
* A charge on the seller\'s account. Possible values: * Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. * Tax - The tax collected by the seller on the Principal. * MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. * MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. * MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. * MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. * Discount - The promotional discount for an order item. * TaxDiscount - The tax amount deducted for promotional rebates. * CODItemCharge - The COD charge for an order item. * CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. * CODOrderCharge - The COD charge for an order. * CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. * CODShippingCharge - Shipping charges for a COD order. * CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. * ShippingCharge - The shipping charge. * ShippingTax - The tax collected by the seller on a ShippingCharge. * Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. * Giftwrap - The gift wrap charge. * GiftwrapTax - The tax collected by the seller on a Giftwrap charge. * RestockingFee - The charge applied to the buyer when returning a product in certain categories. * ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault. * PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. * GenericDeduction - A generic bad debt deduction. * FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. * PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces. * ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. * SAFE-TReimbursement - The SAFE-T claim amount for the item. * TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). * TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST). * TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST). * TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST).
* @export
* @interface ChargeComponent
*/
export interface ChargeComponent {
/**
* The type of charge.
* @type {string}
* @memberof ChargeComponent
*/
ChargeType?: string;
/**
*
* @type {Currency}
* @memberof ChargeComponent
*/
ChargeAmount?: 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;
}
/**
* An event related to charge refund.
* @export
* @interface ChargeRefundEvent
*/
export interface ChargeRefundEvent {
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof ChargeRefundEvent
*/
PostedDate?: string;
/**
* The reason given for a charge refund. Example: `SubscriptionFeeCorrection`
* @type {string}
* @memberof ChargeRefundEvent
*/
ReasonCode?: string;
/**
* A description of the Reason Code. Example: `SubscriptionFeeCorrection`
* @type {string}
* @memberof ChargeRefundEvent
*/
ReasonCodeDescription?: string;
/**
* A list of `ChargeRefund` transactions
* @type {Array<ChargeRefundTransaction>}
* @memberof ChargeRefundEvent
*/
ChargeRefundTransactions?: Array<ChargeRefundTransaction>;
}
/**
* The charge refund transaction.
* @export
* @interface ChargeRefundTransaction
*/
export interface ChargeRefundTransaction {
/**
*
* @type {Currency}
* @memberof ChargeRefundTransaction
*/
ChargeAmount?: Currency;
/**
* The type of charge.
* @type {string}
* @memberof ChargeRefundTransaction
*/
ChargeType?: string;
}
/**
* An event related to coupon payments.
* @export
* @interface CouponPaymentEvent
*/
export interface CouponPaymentEvent {
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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;
}
/**
* 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;
/**
* Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount).
* @type {number}
* @memberof Currency
*/
CurrencyAmount?: number;
}
/**
* 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>;
}
/**
* 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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof DebtRecoveryItem
*/
GroupBeginDate?: string;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof DebtRecoveryItem
*/
GroupEndDate?: string;
}
/**
* 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;
}
/**
* 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 {
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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;
}
/**
* Failed ad hoc disbursement event list.
* @export
* @interface FailedAdhocDisbursementEvent
*/
export interface FailedAdhocDisbursementEvent {
/**
* The type of fund transfer. Example \"Refund\"
* @type {string}
* @memberof FailedAdhocDisbursementEvent
*/
FundsTransfersType?: string;
/**
* The transfer identifier.
* @type {string}
* @memberof FailedAdhocDisbursementEvent
*/
TransferId?: string;
/**
* The disbursement identifier.
* @type {string}
* @memberof FailedAdhocDisbursementEvent
*/
DisbursementId?: string;
/**
* The type of payment for disbursement. Example `CREDIT_CARD`
* @type {string}
* @memberof FailedAdhocDisbursementEvent
*/
PaymentDisbursementType?: string;
/**
* The status of the failed `AdhocDisbursement`. Example `HARD_DECLINED`
* @type {string}
* @memberof FailedAdhocDisbursementEvent
*/
Status?: string;
/**
*
* @type {Currency}
* @memberof FailedAdhocDisbursementEvent
*/
TransferAmount?: Currency;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof FailedAdhocDisbursementEvent
*/
PostedDate?: string;
}
/**
* 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;
}
/**
* 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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof FinancialEventGroup
*/
FinancialEventGroupStart?: string;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof FinancialEventGroup
*/
FinancialEventGroupEnd?: string;
}
/**
* 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 `ShipmentEvent` items.
* @type {Array<ShipmentEvent>}
* @memberof FinancialEvents
*/
ShipmentSettleEventList?: 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 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>;
/**
* A list of information about trial shipment financial events.
* @type {Array<TrialShipmentEvent>}
* @memberof FinancialEvents
*/
TrialShipmentEventList?: Array<TrialShipmentEvent>;
/**
* A list of `TDSReimbursementEvent` items.
* @type {Array<TDSReimbursementEvent>}
* @memberof FinancialEvents
*/
TDSReimbursementEventList?: Array<TDSReimbursementEvent>;
/**
* A list of `AdhocDisbursement` events.
* @type {Array<AdhocDisbursementEvent>}
* @memberof FinancialEvents
*/
AdhocDisbursementEventList?: Array<AdhocDisbursementEvent>;
/**
* A list of `TaxWithholding` events.
* @type {Array<TaxWithholdingEvent>}
* @memberof FinancialEvents
*/
TaxWithholdingEventList?: Array<TaxWithholdingEvent>;
/**
* A list of charge refund events.
* @type {Array<ChargeRefundEvent>}
* @memberof FinancialEvents
*/
ChargeRefundEventList?: Array<ChargeRefundEvent>;
/**
* A list of `FailedAdhocDisbursementEvent`s.
* @type {Array<FailedAdhocDisbursementEvent>}
* @memberof FinancialEvents
*/
FailedAdhocDisbursementEventList?: Array<FailedAdhocDisbursementEvent>;
/**
* A list of `ValueAddedServiceCharge` events.
* @type {Array<ValueAddedServiceChargeEvent>}
* @memberof FinancialEvents
*/
ValueAddedServiceChargeEventList?: Array<ValueAddedServiceChargeEvent>;
/**
* A list of `CapacityReservationBillingEvent` events.
* @type {Array<CapacityReservationBillingEvent>}
* @memberof FinancialEvents
*/
CapacityReservationBillingEventList?: Array<CapacityReservationBillingEvent>;
}
/**
* 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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof ImagingServicesFeeEvent
*/
PostedDate?: string;
/**
* A list of fee component information.
* @type {Array<FeeComponent>}
* @memberof ImagingServicesFeeEvent
*/
FeeList?: Array<FeeComponent>;
}
/**
* 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>;
}
/**
* 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>;
}
/**
* 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;
}
/**
* 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>;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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;
}
/**
* 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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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;
}
/**
* A Sponsored Products payment event.
* @export
* @interface ProductAdsPaymentEvent
*/
export interface ProductAdsPaymentEvent {
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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;
}
/**
* 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;
}
/**
* A financial adjustment event for FBA liquidated inventory. A positive value indicates money owed to Amazon by the buyer (for example, when the charge was incorrectly calculated as less than it should be). A negative value indicates a full or partial refund owed to the buyer (for example, when the buyer receives damaged items or fewer items than ordered).
* @export
* @interface RemovalShipmentAdjustmentEvent
*/
export interface RemovalShipmentAdjustmentEvent {
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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>;
}
/**
* A removal shipment event for a removal order.
* @export
* @interface RemovalShipmentEvent
*/
export interface RemovalShipmentEvent {
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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;
/**
* The name of the store where the event occurred.
* @type {string}
* @memberof RemovalShipmentEvent
*/
StoreName?: string;
/**
* A list of information about removal shipment items.
* @type {Array<RemovalShipmentItem>}
* @memberof RemovalShipmentEvent
*/
RemovalShipmentItemList?: Array<RemovalShipmentItem>;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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>;
}
/**
* 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;
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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>;
}
/**
* A SAFE-T claim reimbursement on the seller\'s account.
* @export
* @interface SAFETReimbursementEvent
*/
export interface SAFETReimbursementEvent {
/**
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @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>;
}
/**
* An item from a SAFE-T claim reimbursement.
* @export
* @interface SAFETReimbursementItem
*/
export interface SAFETReimbursementItem {
/**
* A list of charge information on the seller\'s account.
* @type {Array<ChargeComponent>}
* @memberof SAFETReimbursementItem
*/
itemChargeList?: Array<ChargeComponent>;
/**
* The description of the item as shown on the product detail page on the retail website.
* @type {string}
* @memberof SAFETReimbursementItem
*/
productDescription?: string;
/**
* The number of units of the item being reimbursed.
* @type {string}
* @memberof SAFETReimbursementItem
*/
quantity?: string;
}
/**
* An event linked to the payment of a fee related to the specified de