@sp-api-sdk/finances-api-v0 2.6.1 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/api-model/api/default-api.js +45 -45
  3. package/dist/cjs/api-model/api.js +1 -1
  4. package/dist/cjs/api-model/base.js +1 -1
  5. package/dist/cjs/api-model/common.js +1 -1
  6. package/dist/cjs/api-model/configuration.js +1 -1
  7. package/dist/cjs/api-model/index.js +1 -1
  8. package/dist/cjs/api-model/models/adhoc-disbursement-event.js +1 -1
  9. package/dist/cjs/api-model/models/adjustment-event.js +1 -1
  10. package/dist/cjs/api-model/models/adjustment-item.js +1 -1
  11. package/dist/cjs/api-model/models/affordability-expense-event.js +1 -1
  12. package/dist/cjs/api-model/models/capacity-reservation-billing-event.js +1 -1
  13. package/dist/cjs/api-model/models/charge-component.js +1 -1
  14. package/dist/cjs/api-model/models/charge-instrument.js +1 -1
  15. package/dist/cjs/api-model/models/charge-refund-event.js +1 -1
  16. package/dist/cjs/api-model/models/charge-refund-transaction.js +1 -1
  17. package/dist/cjs/api-model/models/coupon-payment-event.js +1 -1
  18. package/dist/cjs/api-model/models/currency.js +1 -1
  19. package/dist/cjs/api-model/models/debt-recovery-event.js +1 -1
  20. package/dist/cjs/api-model/models/debt-recovery-item.js +1 -1
  21. package/dist/cjs/api-model/models/direct-payment.js +1 -1
  22. package/dist/cjs/api-model/models/failed-adhoc-disbursement-event.js +1 -1
  23. package/dist/cjs/api-model/models/fbaliquidation-event.js +1 -1
  24. package/dist/cjs/api-model/models/fee-component.js +1 -1
  25. package/dist/cjs/api-model/models/financial-event-group.js +1 -1
  26. package/dist/cjs/api-model/models/financial-events.js +1 -1
  27. package/dist/cjs/api-model/models/imaging-services-fee-event.js +1 -1
  28. package/dist/cjs/api-model/models/list-financial-event-groups-payload.js +1 -1
  29. package/dist/cjs/api-model/models/list-financial-event-groups-response.js +1 -1
  30. package/dist/cjs/api-model/models/list-financial-events-payload.js +1 -1
  31. package/dist/cjs/api-model/models/list-financial-events-response.js +1 -1
  32. package/dist/cjs/api-model/models/loan-servicing-event.js +1 -1
  33. package/dist/cjs/api-model/models/model-error.js +1 -1
  34. package/dist/cjs/api-model/models/network-commingling-transaction-event.js +1 -1
  35. package/dist/cjs/api-model/models/pay-with-amazon-event.js +1 -1
  36. package/dist/cjs/api-model/models/product-ads-payment-event.js +1 -1
  37. package/dist/cjs/api-model/models/promotion.js +1 -1
  38. package/dist/cjs/api-model/models/removal-shipment-adjustment-event.js +1 -1
  39. package/dist/cjs/api-model/models/removal-shipment-event.js +1 -1
  40. package/dist/cjs/api-model/models/removal-shipment-item-adjustment.js +1 -1
  41. package/dist/cjs/api-model/models/removal-shipment-item.js +1 -1
  42. package/dist/cjs/api-model/models/rental-transaction-event.js +1 -1
  43. package/dist/cjs/api-model/models/retrocharge-event.js +1 -1
  44. package/dist/cjs/api-model/models/safetreimbursement-event.js +1 -1
  45. package/dist/cjs/api-model/models/safetreimbursement-item.js +1 -1
  46. package/dist/cjs/api-model/models/seller-deal-payment-event.js +1 -1
  47. package/dist/cjs/api-model/models/seller-review-enrollment-payment-event.js +1 -1
  48. package/dist/cjs/api-model/models/service-fee-event.js +1 -1
  49. package/dist/cjs/api-model/models/shipment-event.js +1 -1
  50. package/dist/cjs/api-model/models/shipment-item.js +1 -1
  51. package/dist/cjs/api-model/models/solution-provider-credit-event.js +1 -1
  52. package/dist/cjs/api-model/models/tax-withheld-component.js +1 -1
  53. package/dist/cjs/api-model/models/tax-withholding-event.js +1 -1
  54. package/dist/cjs/api-model/models/tax-withholding-period.js +1 -1
  55. package/dist/cjs/api-model/models/tdsreimbursement-event.js +1 -1
  56. package/dist/cjs/api-model/models/trial-shipment-event.js +1 -1
  57. package/dist/cjs/api-model/models/value-added-service-charge-event.js +1 -1
  58. package/dist/es/api-model/api/default-api.js +45 -45
  59. package/dist/es/api-model/api.js +1 -1
  60. package/dist/es/api-model/base.js +1 -1
  61. package/dist/es/api-model/common.js +1 -1
  62. package/dist/es/api-model/configuration.js +1 -1
  63. package/dist/es/api-model/index.js +1 -1
  64. package/dist/es/api-model/models/adhoc-disbursement-event.js +1 -1
  65. package/dist/es/api-model/models/adjustment-event.js +1 -1
  66. package/dist/es/api-model/models/adjustment-item.js +1 -1
  67. package/dist/es/api-model/models/affordability-expense-event.js +1 -1
  68. package/dist/es/api-model/models/capacity-reservation-billing-event.js +1 -1
  69. package/dist/es/api-model/models/charge-component.js +1 -1
  70. package/dist/es/api-model/models/charge-instrument.js +1 -1
  71. package/dist/es/api-model/models/charge-refund-event.js +1 -1
  72. package/dist/es/api-model/models/charge-refund-transaction.js +1 -1
  73. package/dist/es/api-model/models/coupon-payment-event.js +1 -1
  74. package/dist/es/api-model/models/currency.js +1 -1
  75. package/dist/es/api-model/models/debt-recovery-event.js +1 -1
  76. package/dist/es/api-model/models/debt-recovery-item.js +1 -1
  77. package/dist/es/api-model/models/direct-payment.js +1 -1
  78. package/dist/es/api-model/models/failed-adhoc-disbursement-event.js +1 -1
  79. package/dist/es/api-model/models/fbaliquidation-event.js +1 -1
  80. package/dist/es/api-model/models/fee-component.js +1 -1
  81. package/dist/es/api-model/models/financial-event-group.js +1 -1
  82. package/dist/es/api-model/models/financial-events.js +1 -1
  83. package/dist/es/api-model/models/imaging-services-fee-event.js +1 -1
  84. package/dist/es/api-model/models/list-financial-event-groups-payload.js +1 -1
  85. package/dist/es/api-model/models/list-financial-event-groups-response.js +1 -1
  86. package/dist/es/api-model/models/list-financial-events-payload.js +1 -1
  87. package/dist/es/api-model/models/list-financial-events-response.js +1 -1
  88. package/dist/es/api-model/models/loan-servicing-event.js +1 -1
  89. package/dist/es/api-model/models/model-error.js +1 -1
  90. package/dist/es/api-model/models/network-commingling-transaction-event.js +1 -1
  91. package/dist/es/api-model/models/pay-with-amazon-event.js +1 -1
  92. package/dist/es/api-model/models/product-ads-payment-event.js +1 -1
  93. package/dist/es/api-model/models/promotion.js +1 -1
  94. package/dist/es/api-model/models/removal-shipment-adjustment-event.js +1 -1
  95. package/dist/es/api-model/models/removal-shipment-event.js +1 -1
  96. package/dist/es/api-model/models/removal-shipment-item-adjustment.js +1 -1
  97. package/dist/es/api-model/models/removal-shipment-item.js +1 -1
  98. package/dist/es/api-model/models/rental-transaction-event.js +1 -1
  99. package/dist/es/api-model/models/retrocharge-event.js +1 -1
  100. package/dist/es/api-model/models/safetreimbursement-event.js +1 -1
  101. package/dist/es/api-model/models/safetreimbursement-item.js +1 -1
  102. package/dist/es/api-model/models/seller-deal-payment-event.js +1 -1
  103. package/dist/es/api-model/models/seller-review-enrollment-payment-event.js +1 -1
  104. package/dist/es/api-model/models/service-fee-event.js +1 -1
  105. package/dist/es/api-model/models/shipment-event.js +1 -1
  106. package/dist/es/api-model/models/shipment-item.js +1 -1
  107. package/dist/es/api-model/models/solution-provider-credit-event.js +1 -1
  108. package/dist/es/api-model/models/tax-withheld-component.js +1 -1
  109. package/dist/es/api-model/models/tax-withholding-event.js +1 -1
  110. package/dist/es/api-model/models/tax-withholding-period.js +1 -1
  111. package/dist/es/api-model/models/tdsreimbursement-event.js +1 -1
  112. package/dist/es/api-model/models/trial-shipment-event.js +1 -1
  113. package/dist/es/api-model/models/value-added-service-charge-event.js +1 -1
  114. package/dist/types/api-model/api/default-api.d.ts +59 -59
  115. package/dist/types/api-model/api.d.ts +1 -1
  116. package/dist/types/api-model/base.d.ts +1 -1
  117. package/dist/types/api-model/common.d.ts +1 -1
  118. package/dist/types/api-model/configuration.d.ts +1 -1
  119. package/dist/types/api-model/index.d.ts +1 -1
  120. package/dist/types/api-model/models/adhoc-disbursement-event.d.ts +3 -3
  121. package/dist/types/api-model/models/adjustment-event.d.ts +3 -3
  122. package/dist/types/api-model/models/adjustment-item.d.ts +8 -2
  123. package/dist/types/api-model/models/affordability-expense-event.d.ts +4 -4
  124. package/dist/types/api-model/models/capacity-reservation-billing-event.d.ts +3 -3
  125. package/dist/types/api-model/models/charge-component.d.ts +2 -2
  126. package/dist/types/api-model/models/charge-instrument.d.ts +1 -1
  127. package/dist/types/api-model/models/charge-refund-event.d.ts +4 -4
  128. package/dist/types/api-model/models/charge-refund-transaction.d.ts +1 -1
  129. package/dist/types/api-model/models/coupon-payment-event.d.ts +2 -2
  130. package/dist/types/api-model/models/currency.d.ts +2 -2
  131. package/dist/types/api-model/models/debt-recovery-event.d.ts +2 -2
  132. package/dist/types/api-model/models/debt-recovery-item.d.ts +3 -3
  133. package/dist/types/api-model/models/direct-payment.d.ts +2 -2
  134. package/dist/types/api-model/models/failed-adhoc-disbursement-event.d.ts +5 -5
  135. package/dist/types/api-model/models/fbaliquidation-event.d.ts +2 -2
  136. package/dist/types/api-model/models/fee-component.d.ts +1 -1
  137. package/dist/types/api-model/models/financial-event-group.d.ts +5 -5
  138. package/dist/types/api-model/models/financial-events.d.ts +8 -8
  139. package/dist/types/api-model/models/imaging-services-fee-event.d.ts +2 -2
  140. package/dist/types/api-model/models/list-financial-event-groups-payload.d.ts +2 -2
  141. package/dist/types/api-model/models/list-financial-event-groups-response.d.ts +2 -2
  142. package/dist/types/api-model/models/list-financial-events-payload.d.ts +2 -2
  143. package/dist/types/api-model/models/list-financial-events-response.d.ts +2 -2
  144. package/dist/types/api-model/models/loan-servicing-event.d.ts +2 -2
  145. package/dist/types/api-model/models/model-error.d.ts +1 -1
  146. package/dist/types/api-model/models/network-commingling-transaction-event.d.ts +3 -3
  147. package/dist/types/api-model/models/pay-with-amazon-event.d.ts +5 -5
  148. package/dist/types/api-model/models/product-ads-payment-event.d.ts +4 -4
  149. package/dist/types/api-model/models/promotion.d.ts +1 -1
  150. package/dist/types/api-model/models/removal-shipment-adjustment-event.d.ts +4 -4
  151. package/dist/types/api-model/models/removal-shipment-event.d.ts +5 -5
  152. package/dist/types/api-model/models/removal-shipment-item-adjustment.d.ts +3 -3
  153. package/dist/types/api-model/models/removal-shipment-item.d.ts +2 -2
  154. package/dist/types/api-model/models/rental-transaction-event.d.ts +4 -4
  155. package/dist/types/api-model/models/retrocharge-event.d.ts +3 -3
  156. package/dist/types/api-model/models/safetreimbursement-event.d.ts +3 -3
  157. package/dist/types/api-model/models/safetreimbursement-item.d.ts +1 -1
  158. package/dist/types/api-model/models/seller-deal-payment-event.d.ts +4 -4
  159. package/dist/types/api-model/models/seller-review-enrollment-payment-event.d.ts +2 -2
  160. package/dist/types/api-model/models/service-fee-event.d.ts +1 -1
  161. package/dist/types/api-model/models/shipment-event.d.ts +2 -2
  162. package/dist/types/api-model/models/shipment-item.d.ts +1 -1
  163. package/dist/types/api-model/models/solution-provider-credit-event.d.ts +2 -2
  164. package/dist/types/api-model/models/tax-withheld-component.d.ts +2 -2
  165. package/dist/types/api-model/models/tax-withholding-event.d.ts +3 -3
  166. package/dist/types/api-model/models/tax-withholding-period.d.ts +4 -4
  167. package/dist/types/api-model/models/tdsreimbursement-event.d.ts +2 -2
  168. package/dist/types/api-model/models/trial-shipment-event.d.ts +2 -2
  169. package/dist/types/api-model/models/value-added-service-charge-event.d.ts +3 -3
  170. package/package.json +4 -4
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,13 +17,13 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface CapacityReservationBillingEvent {
19
19
  /**
20
- * The transaction type. For example, FBA Inventory Fee.
20
+ * Indicates the type of transaction. For example, FBA Inventory Fee
21
21
  * @type {string}
22
22
  * @memberof CapacityReservationBillingEvent
23
23
  */
24
24
  'TransactionType'?: string;
25
25
  /**
26
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
26
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
27
27
  * @type {string}
28
28
  * @memberof CapacityReservationBillingEvent
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { Currency } from './currency';
13
13
  /**
14
- * A charge on the seller\'s account. Possible values: * `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered. * `Tax`: The tax on the principal that is collected by the seller. * `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal. * `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`. * `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge. * `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges. * `Discount`: The promotional discount for an order item. * `TaxDiscount`: The tax that is deducted for promotional rebates. * `CODItemCharge`: The COD charge for an order item. * `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`. * `CODOrderCharge`: The COD charge for an order. * `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`. * `CODShippingCharge`: Shipping charges for a COD order. * `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`. * `ShippingCharge`: The shipping charge. * `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`. * `Goodwill`: The amount of money that is 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 that is collected by the seller on a gift wrap charge. * `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories. * `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if 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 that is 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).
14
+ * 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).
15
15
  * @export
16
16
  * @interface ChargeComponent
17
17
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,19 +17,19 @@ import type { ChargeRefundTransaction } from './charge-refund-transaction';
17
17
  */
18
18
  export interface ChargeRefundEvent {
19
19
  /**
20
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
21
  * @type {string}
22
22
  * @memberof ChargeRefundEvent
23
23
  */
24
24
  'PostedDate'?: string;
25
25
  /**
26
- * The reason given for a charge refund. For example, `SubscriptionFeeCorrection`.
26
+ * The reason given for a charge refund. Example: `SubscriptionFeeCorrection`
27
27
  * @type {string}
28
28
  * @memberof ChargeRefundEvent
29
29
  */
30
30
  'ReasonCode'?: string;
31
31
  /**
32
- * A description of the Reason Code. For example, `SubscriptionFeeCorrection`.
32
+ * A description of the Reason Code. Example: `SubscriptionFeeCorrection`
33
33
  * @type {string}
34
34
  * @memberof ChargeRefundEvent
35
35
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -19,7 +19,7 @@ import type { FeeComponent } from './fee-component';
19
19
  */
20
20
  export interface CouponPaymentEvent {
21
21
  /**
22
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
22
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
23
23
  * @type {string}
24
24
  * @memberof CouponPaymentEvent
25
25
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -22,7 +22,7 @@ export interface Currency {
22
22
  */
23
23
  'CurrencyCode'?: string;
24
24
  /**
25
- * A signed decimal number.
25
+ * Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount).
26
26
  * @type {number}
27
27
  * @memberof Currency
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -19,7 +19,7 @@ import type { DebtRecoveryItem } from './debt-recovery-item';
19
19
  */
20
20
  export interface DebtRecoveryEvent {
21
21
  /**
22
- * The debt recovery type. Possible values: * `DebtPayment` * `DebtPaymentFailure` * `DebtAdjustment`
22
+ * The debt recovery type. Possible values: * DebtPayment * DebtPaymentFailure * DebtAdjustment
23
23
  * @type {string}
24
24
  * @memberof DebtRecoveryEvent
25
25
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -29,13 +29,13 @@ export interface DebtRecoveryItem {
29
29
  */
30
30
  'OriginalAmount'?: Currency;
31
31
  /**
32
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
32
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
33
33
  * @type {string}
34
34
  * @memberof DebtRecoveryItem
35
35
  */
36
36
  'GroupBeginDate'?: string;
37
37
  /**
38
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
38
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
39
39
  * @type {string}
40
40
  * @memberof DebtRecoveryItem
41
41
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface DirectPayment {
19
19
  /**
20
- * 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 purchased 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 purchased 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.
20
+ * 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.
21
21
  * @type {string}
22
22
  * @memberof DirectPayment
23
23
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface FailedAdhocDisbursementEvent {
19
19
  /**
20
- * The type of fund transfer. For example, `Refund`.
20
+ * The type of fund transfer. Example \"Refund\"
21
21
  * @type {string}
22
22
  * @memberof FailedAdhocDisbursementEvent
23
23
  */
@@ -35,13 +35,13 @@ export interface FailedAdhocDisbursementEvent {
35
35
  */
36
36
  'DisbursementId'?: string;
37
37
  /**
38
- * The type of payment for disbursement. For example, `CREDIT_CARD`.
38
+ * The type of payment for disbursement. Example `CREDIT_CARD`
39
39
  * @type {string}
40
40
  * @memberof FailedAdhocDisbursementEvent
41
41
  */
42
42
  'PaymentDisbursementType'?: string;
43
43
  /**
44
- * The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`.
44
+ * The status of the failed `AdhocDisbursement`. Example `HARD_DECLINED`
45
45
  * @type {string}
46
46
  * @memberof FailedAdhocDisbursementEvent
47
47
  */
@@ -53,7 +53,7 @@ export interface FailedAdhocDisbursementEvent {
53
53
  */
54
54
  'TransferAmount'?: Currency;
55
55
  /**
56
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
56
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
57
57
  * @type {string}
58
58
  * @memberof FailedAdhocDisbursementEvent
59
59
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface FBALiquidationEvent {
19
19
  /**
20
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
21
  * @type {string}
22
22
  * @memberof FBALiquidationEvent
23
23
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -23,7 +23,7 @@ export interface FinancialEventGroup {
23
23
  */
24
24
  'FinancialEventGroupId'?: string;
25
25
  /**
26
- * The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: * `Open` * `Closed`
26
+ * The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: * Open * Closed
27
27
  * @type {string}
28
28
  * @memberof FinancialEventGroup
29
29
  */
@@ -47,7 +47,7 @@ export interface FinancialEventGroup {
47
47
  */
48
48
  'ConvertedTotal'?: Currency;
49
49
  /**
50
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
50
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
51
51
  * @type {string}
52
52
  * @memberof FinancialEventGroup
53
53
  */
@@ -71,13 +71,13 @@ export interface FinancialEventGroup {
71
71
  */
72
72
  'BeginningBalance'?: Currency;
73
73
  /**
74
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
74
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
75
75
  * @type {string}
76
76
  * @memberof FinancialEventGroup
77
77
  */
78
78
  'FinancialEventGroupStart'?: string;
79
79
  /**
80
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
80
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
81
81
  * @type {string}
82
82
  * @memberof FinancialEventGroup
83
83
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -38,7 +38,7 @@ import type { TaxWithholdingEvent } from './tax-withholding-event';
38
38
  import type { TrialShipmentEvent } from './trial-shipment-event';
39
39
  import type { ValueAddedServiceChargeEvent } from './value-added-service-charge-event';
40
40
  /**
41
- * All the information that is related to a financial event.
41
+ * Contains all information related to a financial event.
42
42
  * @export
43
43
  * @interface FinancialEvents
44
44
  */
@@ -80,13 +80,13 @@ export interface FinancialEvents {
80
80
  */
81
81
  'PayWithAmazonEventList'?: Array<PayWithAmazonEvent>;
82
82
  /**
83
- * A list of `SolutionProviderCreditEvent`.
83
+ * A list of information about solution provider credits.
84
84
  * @type {Array<SolutionProviderCreditEvent>}
85
85
  * @memberof FinancialEvents
86
86
  */
87
87
  'ServiceProviderCreditEventList'?: Array<SolutionProviderCreditEvent>;
88
88
  /**
89
- * A list of information about `Retrocharge` or `RetrochargeReversal` events.
89
+ * A list of information about Retrocharge or RetrochargeReversal events.
90
90
  * @type {Array<RetrochargeEvent>}
91
91
  * @memberof FinancialEvents
92
92
  */
@@ -134,7 +134,7 @@ export interface FinancialEvents {
134
134
  */
135
135
  'AdjustmentEventList'?: Array<AdjustmentEvent>;
136
136
  /**
137
- * A list of `SAFETReimbursementEvent`.
137
+ * A list of SAFETReimbursementEvents.
138
138
  * @type {Array<SAFETReimbursementEvent>}
139
139
  * @memberof FinancialEvents
140
140
  */
@@ -188,7 +188,7 @@ export interface FinancialEvents {
188
188
  */
189
189
  'RemovalShipmentEventList'?: Array<RemovalShipmentEvent>;
190
190
  /**
191
- * A comma-delimited list of `RemovalShipmentAdjustment` details for FBA inventory.
191
+ * A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.
192
192
  * @type {Array<RemovalShipmentAdjustmentEvent>}
193
193
  * @memberof FinancialEvents
194
194
  */
@@ -212,7 +212,7 @@ export interface FinancialEvents {
212
212
  */
213
213
  'AdhocDisbursementEventList'?: Array<AdhocDisbursementEvent>;
214
214
  /**
215
- * A list of tax withholding events.
215
+ * A list of `TaxWithholding` events.
216
216
  * @type {Array<TaxWithholdingEvent>}
217
217
  * @memberof FinancialEvents
218
218
  */
@@ -224,7 +224,7 @@ export interface FinancialEvents {
224
224
  */
225
225
  'ChargeRefundEventList'?: Array<ChargeRefundEvent>;
226
226
  /**
227
- * A list of `FailedAdhocDisbursementEvent`.
227
+ * A list of `FailedAdhocDisbursementEvent`s.
228
228
  * @type {Array<FailedAdhocDisbursementEvent>}
229
229
  * @memberof FinancialEvents
230
230
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -29,7 +29,7 @@ export interface ImagingServicesFeeEvent {
29
29
  */
30
30
  'ASIN'?: string;
31
31
  /**
32
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
32
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
33
33
  * @type {string}
34
34
  * @memberof ImagingServicesFeeEvent
35
35
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { FinancialEventGroup } from './financial-event-group';
13
13
  /**
14
- * The payload for the `listFinancialEventGroups` operation.
14
+ * The payload for the listFinancialEventGroups operation.
15
15
  * @export
16
16
  * @interface ListFinancialEventGroupsPayload
17
17
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ListFinancialEventGroupsPayload } from './list-financial-event-groups-payload';
13
13
  /**
14
- * The response schema for the `listFinancialEventGroups` operation.
14
+ * The response schema for the listFinancialEventGroups operation.
15
15
  * @export
16
16
  * @interface ListFinancialEventGroupsResponse
17
17
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { FinancialEvents } from './financial-events';
13
13
  /**
14
- * The payload for the `listFinancialEvents` operation.
14
+ * The payload for the listFinancialEvents operation.
15
15
  * @export
16
16
  * @interface ListFinancialEventsPayload
17
17
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ListFinancialEventsPayload } from './list-financial-events-payload';
13
13
  /**
14
- * The response schema for the `listFinancialEvents` operation.
14
+ * The response schema for the listFinancialEvents operation.
15
15
  * @export
16
16
  * @interface ListFinancialEventsResponse
17
17
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -23,7 +23,7 @@ export interface LoanServicingEvent {
23
23
  */
24
24
  'LoanAmount'?: Currency;
25
25
  /**
26
- * The type of event. Possible values: * `LoanAdvance` * `LoanPayment` * `LoanRefund`
26
+ * The type of event. Possible values: * LoanAdvance * LoanPayment * LoanRefund
27
27
  * @type {string}
28
28
  * @memberof LoanServicingEvent
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,13 +17,13 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface NetworkComminglingTransactionEvent {
19
19
  /**
20
- * 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 Spain, UK, France, Germany, and Italy marketplaces.
20
+ * 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.
21
21
  * @type {string}
22
22
  * @memberof NetworkComminglingTransactionEvent
23
23
  */
24
24
  'TransactionType'?: string;
25
25
  /**
26
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
26
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
27
27
  * @type {string}
28
28
  * @memberof NetworkComminglingTransactionEvent
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -24,7 +24,7 @@ export interface PayWithAmazonEvent {
24
24
  */
25
25
  'SellerOrderId'?: string;
26
26
  /**
27
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
27
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
28
28
  * @type {string}
29
29
  * @memberof PayWithAmazonEvent
30
30
  */
@@ -54,7 +54,7 @@ export interface PayWithAmazonEvent {
54
54
  */
55
55
  'FeeList'?: Array<FeeComponent>;
56
56
  /**
57
- * The type of payment. Possible values: * `Sales`
57
+ * The type of payment. Possible values: * Sales
58
58
  * @type {string}
59
59
  * @memberof PayWithAmazonEvent
60
60
  */
@@ -66,13 +66,13 @@ export interface PayWithAmazonEvent {
66
66
  */
67
67
  'AmountDescription'?: string;
68
68
  /**
69
- * The fulfillment channel. Possible values: * `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon) * `MFN`: Merchant Fulfillment Network (self-fulfilled)
69
+ * The fulfillment channel. Possible values: * AFN - Amazon Fulfillment Network (Fulfillment by Amazon) * MFN - Merchant Fulfillment Network (self-fulfilled)
70
70
  * @type {string}
71
71
  * @memberof PayWithAmazonEvent
72
72
  */
73
73
  'FulfillmentChannel'?: string;
74
74
  /**
75
- * The name of the store where the event occurred.
75
+ * The store name where the event occurred.
76
76
  * @type {string}
77
77
  * @memberof PayWithAmazonEvent
78
78
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,19 +17,19 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface ProductAdsPaymentEvent {
19
19
  /**
20
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
21
  * @type {string}
22
22
  * @memberof ProductAdsPaymentEvent
23
23
  */
24
24
  'postedDate'?: string;
25
25
  /**
26
- * Indicates if the transaction is for a charge or a refund. Possible values: * `charge` * `refund`
26
+ * Indicates if the transaction is for a charge or a refund. Possible values: * charge - Charge * refund - Refund
27
27
  * @type {string}
28
28
  * @memberof ProductAdsPaymentEvent
29
29
  */
30
30
  'transactionType'?: string;
31
31
  /**
32
- * The identifier for the invoice that includes the transaction.
32
+ * Identifier for the invoice that the transaction appears in.
33
33
  * @type {string}
34
34
  * @memberof ProductAdsPaymentEvent
35
35
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information that is 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *