From 95d392896fd159d27092e0c34891980de3564e18 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 17 Sep 2021 09:24:21 +0700 Subject: [PATCH] feat: update for tds reimbursement (#244) Co-authored-by: nguyentoanit --- src/api-models/finances-api-model/api.ts | 193 ++++++++++++++++-- src/api-models/index.ts | 5 +- .../merchant-fulfillment-api-model/api.ts | 6 +- .../product-pricing-api-model/api.ts | 6 - src/api-models/sales-api-model/api.ts | 2 +- 5 files changed, 181 insertions(+), 31 deletions(-) diff --git a/src/api-models/finances-api-model/api.ts b/src/api-models/finances-api-model/api.ts index a76772d7..606b933b 100644 --- a/src/api-models/finances-api-model/api.ts +++ b/src/api-models/finances-api-model/api.ts @@ -628,6 +628,36 @@ export interface FinancialEvents { * @memberof FinancialEvents */ AffordabilityExpenseReversalEventList?: Array; + /** + * A list of information about trial shipment financial events. + * @type {Array} + * @memberof FinancialEvents + */ + TrialShipmentEventList?: Array; + /** + * A list of information about shipment settle financial events. + * @type {Array} + * @memberof FinancialEvents + */ + ShipmentSettleEventList?: Array; + /** + * List of TaxWithholding events. + * @type {Array} + * @memberof FinancialEvents + */ + TaxWithholdingEventList?: Array; + /** + * A list of removal shipment event information. + * @type {Array} + * @memberof FinancialEvents + */ + RemovalShipmentEventList?: Array; + /** + * A comma-delimited list of Removal shipmentAdjustment details for FBA inventory. + * @type {Array} + * @memberof FinancialEvents + */ + RemovalShipmentAdjustmentEventList?: Array; } /** * A fee event related to Amazon Imaging services. @@ -970,6 +1000,49 @@ export interface Promotion { */ PromotionAmount?: Currency; } +/** + * 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} + * @memberof RemovalShipmentAdjustmentEvent + */ + RemovalShipmentItemAdjustmentList?: Array; +} /** * A removal shipment event for a removal order. * @export @@ -982,6 +1055,12 @@ export interface RemovalShipmentEvent { * @memberof RemovalShipmentEvent */ PostedDate?: string; + /** + * The merchant removal orderId. + * @type {string} + * @memberof RemovalShipmentEvent + */ + MerchantOrderId?: string; /** * The identifier for the removal shipment order. * @type {string} @@ -1056,6 +1135,55 @@ export interface 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 @@ -1619,48 +1747,73 @@ export interface SolutionProviderCreditEvent { TransactionCreationDate?: string; } /** - * A tax deduction at source (TDS) claim reimbursement event on the seller\'s account. + * Information about the taxes withheld. * @export - * @interface TDSReimbursementEvent + * @interface TaxWithheldComponent */ -export interface TDSReimbursementEvent { +export interface TaxWithheldComponent { + /** + * 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 TaxWithheldComponent + */ + TaxCollectionModel?: string; + /** + * A list of charge information on the seller\'s account. + * @type {Array} + * @memberof TaxWithheldComponent + */ + TaxesWithheld?: Array; +} +/** + * A TaxWithholding event on seller\'s account. + * @export + * @interface TaxWithholdingEvent + */ +export interface TaxWithholdingEvent { /** * * @type {string} - * @memberof TDSReimbursementEvent + * @memberof TaxWithholdingEvent */ PostedDate?: string; /** - * A tax deduction at source (TDS) claim identifier. - * @type {string} - * @memberof TDSReimbursementEvent + * + * @type {Currency} + * @memberof TaxWithholdingEvent */ - TdsOrderId?: string; + BaseAmount?: Currency; /** * * @type {Currency} - * @memberof TDSReimbursementEvent + * @memberof TaxWithholdingEvent */ - ReimbursedAmount?: Currency; + WithheldAmount?: Currency; + /** + * + * @type {TaxWithholdingPeriod} + * @memberof TaxWithholdingEvent + */ + TaxWithholdingPeriod?: TaxWithholdingPeriod; } /** - * Information about the taxes withheld. + * Period which taxwithholding on seller\'s account is calculated. * @export - * @interface TaxWithheldComponent + * @interface TaxWithholdingPeriod */ -export interface TaxWithheldComponent { +export interface TaxWithholdingPeriod { /** - * 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 TaxWithheldComponent + * @memberof TaxWithholdingPeriod */ - TaxCollectionModel?: string; + StartDate?: string; /** - * A list of charge information on the seller\'s account. - * @type {Array} - * @memberof TaxWithheldComponent + * + * @type {string} + * @memberof TaxWithholdingPeriod */ - TaxesWithheld?: Array; + EndDate?: string; } /** * An event related to a trial shipment. diff --git a/src/api-models/index.ts b/src/api-models/index.ts index 4d5e73ff..a616f69d 100644 --- a/src/api-models/index.ts +++ b/src/api-models/index.ts @@ -247,8 +247,10 @@ export { PayWithAmazonEvent as FinancesApiModelPayWithAmazonEvent, ProductAdsPaymentEvent as FinancesApiModelProductAdsPaymentEvent, Promotion as FinancesApiModelPromotion, + RemovalShipmentAdjustmentEvent as FinancesApiModelRemovalShipmentAdjustmentEvent, RemovalShipmentEvent as FinancesApiModelRemovalShipmentEvent, RemovalShipmentItem as FinancesApiModelRemovalShipmentItem, + RemovalShipmentItemAdjustment as FinancesApiModelRemovalShipmentItemAdjustment, RentalTransactionEvent as FinancesApiModelRentalTransactionEvent, RetrochargeEvent as FinancesApiModelRetrochargeEvent, SAFETReimbursementEvent as FinancesApiModelSAFETReimbursementEvent, @@ -259,8 +261,9 @@ export { ShipmentEvent as FinancesApiModelShipmentEvent, ShipmentItem as FinancesApiModelShipmentItem, SolutionProviderCreditEvent as FinancesApiModelSolutionProviderCreditEvent, - TDSReimbursementEvent as FinancesApiModelTDSReimbursementEvent, TaxWithheldComponent as FinancesApiModelTaxWithheldComponent, + TaxWithholdingEvent as FinancesApiModelTaxWithholdingEvent, + TaxWithholdingPeriod as FinancesApiModelTaxWithholdingPeriod, TrialShipmentEvent as FinancesApiModelTrialShipmentEvent, DefaultApiListFinancialEventGroupsRequest as FinancesApiModelDefaultApiListFinancialEventGroupsRequest, DefaultApiListFinancialEventsRequest as FinancesApiModelDefaultApiListFinancialEventsRequest, diff --git a/src/api-models/merchant-fulfillment-api-model/api.ts b/src/api-models/merchant-fulfillment-api-model/api.ts index 05214d31..3274693d 100644 --- a/src/api-models/merchant-fulfillment-api-model/api.ts +++ b/src/api-models/merchant-fulfillment-api-model/api.ts @@ -460,7 +460,7 @@ export interface GetAdditionalSellerInputsRequest { */ ShipFromAddress: Address; /** - * An Amazon-defined order identifier, in 3-7-7 format.
**Pattern** : `[0-9A-Z]{3}-[0-9]{7}-[0-9]{7}`. + * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} * @memberof GetAdditionalSellerInputsRequest */ @@ -1038,7 +1038,7 @@ export interface Shipment { */ ShipmentId: string; /** - * An Amazon-defined order identifier, in 3-7-7 format.
**Pattern** : `[0-9A-Z]{3}-[0-9]{7}-[0-9]{7}`. + * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} * @memberof Shipment */ @@ -1129,7 +1129,7 @@ export interface Shipment { */ export interface ShipmentRequestDetails { /** - * An Amazon-defined order identifier, in 3-7-7 format.
**Pattern** : `[0-9A-Z]{3}-[0-9]{7}-[0-9]{7}`. + * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} * @memberof ShipmentRequestDetails */ diff --git a/src/api-models/product-pricing-api-model/api.ts b/src/api-models/product-pricing-api-model/api.ts index f0088734..50178bab 100644 --- a/src/api-models/product-pricing-api-model/api.ts +++ b/src/api-models/product-pricing-api-model/api.ts @@ -541,12 +541,6 @@ export enum OfferCustomerType { * @interface OfferDetail */ export interface OfferDetail { - /** - * The seller identifier for the offer. - * @type {string} - * @memberof OfferDetail - */ - sellerId?: string; /** * When true, this is the seller\'s offer. * @type {boolean} diff --git a/src/api-models/sales-api-model/api.ts b/src/api-models/sales-api-model/api.ts index efbcb0c3..2c860869 100644 --- a/src/api-models/sales-api-model/api.ts +++ b/src/api-models/sales-api-model/api.ts @@ -78,7 +78,7 @@ export interface Money { */ currencyCode: string; /** - * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. + * A decimal number with no loss of precision. Useful when precision loss is unnaceptable, as with currencies. Follows RFC7159 for number representation. * @type {string} * @memberof Money */