@sp-api-sdk/finances-api-v0 4.2.8 → 5.1.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 (188) hide show
  1. package/README.md +8 -9
  2. package/dist/index.cjs +520 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +1747 -0
  5. package/dist/index.d.ts +1747 -0
  6. package/dist/index.js +491 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +26 -12
  9. package/dist/cjs/api-model/api/finances-api.js +0 -365
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/adhoc-disbursement-event.js +0 -15
  16. package/dist/cjs/api-model/models/adjustment-event.js +0 -15
  17. package/dist/cjs/api-model/models/adjustment-item.js +0 -15
  18. package/dist/cjs/api-model/models/affordability-expense-event.js +0 -15
  19. package/dist/cjs/api-model/models/capacity-reservation-billing-event.js +0 -15
  20. package/dist/cjs/api-model/models/charge-component.js +0 -15
  21. package/dist/cjs/api-model/models/charge-instrument.js +0 -15
  22. package/dist/cjs/api-model/models/charge-refund-event.js +0 -15
  23. package/dist/cjs/api-model/models/charge-refund-transaction.js +0 -15
  24. package/dist/cjs/api-model/models/coupon-payment-event.js +0 -15
  25. package/dist/cjs/api-model/models/currency.js +0 -15
  26. package/dist/cjs/api-model/models/debt-recovery-event.js +0 -15
  27. package/dist/cjs/api-model/models/debt-recovery-item.js +0 -15
  28. package/dist/cjs/api-model/models/direct-payment.js +0 -15
  29. package/dist/cjs/api-model/models/ebtrefund-reimbursement-only-event.js +0 -15
  30. package/dist/cjs/api-model/models/failed-adhoc-disbursement-event.js +0 -15
  31. package/dist/cjs/api-model/models/fbaliquidation-event.js +0 -15
  32. package/dist/cjs/api-model/models/fee-component.js +0 -15
  33. package/dist/cjs/api-model/models/financial-event-group.js +0 -15
  34. package/dist/cjs/api-model/models/financial-events.js +0 -15
  35. package/dist/cjs/api-model/models/imaging-services-fee-event.js +0 -15
  36. package/dist/cjs/api-model/models/index.js +0 -67
  37. package/dist/cjs/api-model/models/list-financial-event-groups-payload.js +0 -15
  38. package/dist/cjs/api-model/models/list-financial-event-groups-response.js +0 -15
  39. package/dist/cjs/api-model/models/list-financial-events-payload.js +0 -15
  40. package/dist/cjs/api-model/models/list-financial-events-response.js +0 -15
  41. package/dist/cjs/api-model/models/loan-servicing-event.js +0 -15
  42. package/dist/cjs/api-model/models/model-error.js +0 -15
  43. package/dist/cjs/api-model/models/network-commingling-transaction-event.js +0 -15
  44. package/dist/cjs/api-model/models/pay-with-amazon-event.js +0 -15
  45. package/dist/cjs/api-model/models/product-ads-payment-event.js +0 -15
  46. package/dist/cjs/api-model/models/promotion.js +0 -15
  47. package/dist/cjs/api-model/models/removal-shipment-adjustment-event.js +0 -15
  48. package/dist/cjs/api-model/models/removal-shipment-event.js +0 -15
  49. package/dist/cjs/api-model/models/removal-shipment-item-adjustment.js +0 -15
  50. package/dist/cjs/api-model/models/removal-shipment-item.js +0 -15
  51. package/dist/cjs/api-model/models/rental-transaction-event.js +0 -15
  52. package/dist/cjs/api-model/models/retrocharge-event.js +0 -15
  53. package/dist/cjs/api-model/models/safetreimbursement-event.js +0 -15
  54. package/dist/cjs/api-model/models/safetreimbursement-item.js +0 -15
  55. package/dist/cjs/api-model/models/seller-deal-payment-event.js +0 -15
  56. package/dist/cjs/api-model/models/seller-review-enrollment-payment-event.js +0 -15
  57. package/dist/cjs/api-model/models/service-fee-event.js +0 -15
  58. package/dist/cjs/api-model/models/shipment-event.js +0 -15
  59. package/dist/cjs/api-model/models/shipment-item.js +0 -15
  60. package/dist/cjs/api-model/models/solution-provider-credit-event.js +0 -15
  61. package/dist/cjs/api-model/models/tax-withheld-component.js +0 -15
  62. package/dist/cjs/api-model/models/tax-withholding-event.js +0 -15
  63. package/dist/cjs/api-model/models/tax-withholding-period.js +0 -15
  64. package/dist/cjs/api-model/models/tdsreimbursement-event.js +0 -15
  65. package/dist/cjs/api-model/models/trial-shipment-event.js +0 -15
  66. package/dist/cjs/api-model/models/value-added-service-charge-event.js +0 -15
  67. package/dist/cjs/client.js +0 -42
  68. package/dist/cjs/index.js +0 -18
  69. package/dist/es/api-model/api/finances-api.js +0 -355
  70. package/dist/es/api-model/api.js +0 -14
  71. package/dist/es/api-model/base.js +0 -44
  72. package/dist/es/api-model/common.js +0 -110
  73. package/dist/es/api-model/configuration.js +0 -94
  74. package/dist/es/api-model/index.js +0 -16
  75. package/dist/es/api-model/models/adhoc-disbursement-event.js +0 -14
  76. package/dist/es/api-model/models/adjustment-event.js +0 -14
  77. package/dist/es/api-model/models/adjustment-item.js +0 -14
  78. package/dist/es/api-model/models/affordability-expense-event.js +0 -14
  79. package/dist/es/api-model/models/capacity-reservation-billing-event.js +0 -14
  80. package/dist/es/api-model/models/charge-component.js +0 -14
  81. package/dist/es/api-model/models/charge-instrument.js +0 -14
  82. package/dist/es/api-model/models/charge-refund-event.js +0 -14
  83. package/dist/es/api-model/models/charge-refund-transaction.js +0 -14
  84. package/dist/es/api-model/models/coupon-payment-event.js +0 -14
  85. package/dist/es/api-model/models/currency.js +0 -14
  86. package/dist/es/api-model/models/debt-recovery-event.js +0 -14
  87. package/dist/es/api-model/models/debt-recovery-item.js +0 -14
  88. package/dist/es/api-model/models/direct-payment.js +0 -14
  89. package/dist/es/api-model/models/ebtrefund-reimbursement-only-event.js +0 -14
  90. package/dist/es/api-model/models/failed-adhoc-disbursement-event.js +0 -14
  91. package/dist/es/api-model/models/fbaliquidation-event.js +0 -14
  92. package/dist/es/api-model/models/fee-component.js +0 -14
  93. package/dist/es/api-model/models/financial-event-group.js +0 -14
  94. package/dist/es/api-model/models/financial-events.js +0 -14
  95. package/dist/es/api-model/models/imaging-services-fee-event.js +0 -14
  96. package/dist/es/api-model/models/index.js +0 -51
  97. package/dist/es/api-model/models/list-financial-event-groups-payload.js +0 -14
  98. package/dist/es/api-model/models/list-financial-event-groups-response.js +0 -14
  99. package/dist/es/api-model/models/list-financial-events-payload.js +0 -14
  100. package/dist/es/api-model/models/list-financial-events-response.js +0 -14
  101. package/dist/es/api-model/models/loan-servicing-event.js +0 -14
  102. package/dist/es/api-model/models/model-error.js +0 -14
  103. package/dist/es/api-model/models/network-commingling-transaction-event.js +0 -14
  104. package/dist/es/api-model/models/pay-with-amazon-event.js +0 -14
  105. package/dist/es/api-model/models/product-ads-payment-event.js +0 -14
  106. package/dist/es/api-model/models/promotion.js +0 -14
  107. package/dist/es/api-model/models/removal-shipment-adjustment-event.js +0 -14
  108. package/dist/es/api-model/models/removal-shipment-event.js +0 -14
  109. package/dist/es/api-model/models/removal-shipment-item-adjustment.js +0 -14
  110. package/dist/es/api-model/models/removal-shipment-item.js +0 -14
  111. package/dist/es/api-model/models/rental-transaction-event.js +0 -14
  112. package/dist/es/api-model/models/retrocharge-event.js +0 -14
  113. package/dist/es/api-model/models/safetreimbursement-event.js +0 -14
  114. package/dist/es/api-model/models/safetreimbursement-item.js +0 -14
  115. package/dist/es/api-model/models/seller-deal-payment-event.js +0 -14
  116. package/dist/es/api-model/models/seller-review-enrollment-payment-event.js +0 -14
  117. package/dist/es/api-model/models/service-fee-event.js +0 -14
  118. package/dist/es/api-model/models/shipment-event.js +0 -14
  119. package/dist/es/api-model/models/shipment-item.js +0 -14
  120. package/dist/es/api-model/models/solution-provider-credit-event.js +0 -14
  121. package/dist/es/api-model/models/tax-withheld-component.js +0 -14
  122. package/dist/es/api-model/models/tax-withholding-event.js +0 -14
  123. package/dist/es/api-model/models/tax-withholding-period.js +0 -14
  124. package/dist/es/api-model/models/tdsreimbursement-event.js +0 -14
  125. package/dist/es/api-model/models/trial-shipment-event.js +0 -14
  126. package/dist/es/api-model/models/value-added-service-charge-event.js +0 -14
  127. package/dist/es/client.js +0 -38
  128. package/dist/es/index.js +0 -2
  129. package/dist/types/api-model/api/finances-api.d.ts +0 -257
  130. package/dist/types/api-model/api.d.ts +0 -12
  131. package/dist/types/api-model/base.d.ts +0 -42
  132. package/dist/types/api-model/common.d.ts +0 -34
  133. package/dist/types/api-model/configuration.d.ts +0 -98
  134. package/dist/types/api-model/index.d.ts +0 -14
  135. package/dist/types/api-model/models/adhoc-disbursement-event.d.ts +0 -30
  136. package/dist/types/api-model/models/adjustment-event.d.ts +0 -35
  137. package/dist/types/api-model/models/adjustment-item.d.ts +0 -43
  138. package/dist/types/api-model/models/affordability-expense-event.d.ts +0 -38
  139. package/dist/types/api-model/models/capacity-reservation-billing-event.d.ts +0 -30
  140. package/dist/types/api-model/models/charge-component.d.ts +0 -22
  141. package/dist/types/api-model/models/charge-instrument.d.ts +0 -26
  142. package/dist/types/api-model/models/charge-refund-event.d.ts +0 -33
  143. package/dist/types/api-model/models/charge-refund-transaction.d.ts +0 -22
  144. package/dist/types/api-model/models/coupon-payment-event.d.ts +0 -42
  145. package/dist/types/api-model/models/currency.d.ts +0 -24
  146. package/dist/types/api-model/models/debt-recovery-event.d.ts +0 -33
  147. package/dist/types/api-model/models/debt-recovery-item.d.ts +0 -27
  148. package/dist/types/api-model/models/direct-payment.d.ts +0 -22
  149. package/dist/types/api-model/models/ebtrefund-reimbursement-only-event.d.ts +0 -26
  150. package/dist/types/api-model/models/failed-adhoc-disbursement-event.d.ts +0 -42
  151. package/dist/types/api-model/models/fbaliquidation-event.d.ts +0 -27
  152. package/dist/types/api-model/models/fee-component.d.ts +0 -22
  153. package/dist/types/api-model/models/financial-event-group.d.ts +0 -52
  154. package/dist/types/api-model/models/financial-events.d.ts +0 -181
  155. package/dist/types/api-model/models/imaging-services-fee-event.d.ts +0 -33
  156. package/dist/types/api-model/models/index.d.ts +0 -51
  157. package/dist/types/api-model/models/list-financial-event-groups-payload.d.ts +0 -25
  158. package/dist/types/api-model/models/list-financial-event-groups-response.d.ts +0 -22
  159. package/dist/types/api-model/models/list-financial-events-payload.d.ts +0 -22
  160. package/dist/types/api-model/models/list-financial-events-response.d.ts +0 -22
  161. package/dist/types/api-model/models/loan-servicing-event.d.ts +0 -22
  162. package/dist/types/api-model/models/model-error.d.ts +0 -28
  163. package/dist/types/api-model/models/network-commingling-transaction-event.d.ts +0 -43
  164. package/dist/types/api-model/models/pay-with-amazon-event.d.ts +0 -55
  165. package/dist/types/api-model/models/product-ads-payment-event.d.ts +0 -32
  166. package/dist/types/api-model/models/promotion.d.ts +0 -26
  167. package/dist/types/api-model/models/removal-shipment-adjustment-event.d.ts +0 -41
  168. package/dist/types/api-model/models/removal-shipment-event.d.ts +0 -41
  169. package/dist/types/api-model/models/removal-shipment-item-adjustment.d.ts +0 -36
  170. package/dist/types/api-model/models/removal-shipment-item.d.ts +0 -37
  171. package/dist/types/api-model/models/rental-transaction-event.d.ts +0 -54
  172. package/dist/types/api-model/models/retrocharge-event.d.ts +0 -40
  173. package/dist/types/api-model/models/safetreimbursement-event.d.ts +0 -35
  174. package/dist/types/api-model/models/safetreimbursement-item.d.ts +0 -29
  175. package/dist/types/api-model/models/seller-deal-payment-event.d.ts +0 -40
  176. package/dist/types/api-model/models/seller-review-enrollment-payment-event.d.ts +0 -34
  177. package/dist/types/api-model/models/service-fee-event.d.ts +0 -49
  178. package/dist/types/api-model/models/shipment-event.d.ts +0 -76
  179. package/dist/types/api-model/models/shipment-item.d.ts +0 -67
  180. package/dist/types/api-model/models/solution-provider-credit-event.d.ts +0 -54
  181. package/dist/types/api-model/models/tax-withheld-component.d.ts +0 -25
  182. package/dist/types/api-model/models/tax-withholding-event.d.ts +0 -25
  183. package/dist/types/api-model/models/tax-withholding-period.d.ts +0 -24
  184. package/dist/types/api-model/models/tdsreimbursement-event.d.ts +0 -26
  185. package/dist/types/api-model/models/trial-shipment-event.d.ts +0 -37
  186. package/dist/types/api-model/models/value-added-service-charge-event.d.ts +0 -30
  187. package/dist/types/client.d.ts +0 -6
  188. package/dist/types/index.d.ts +0 -3
@@ -0,0 +1,1747 @@
1
+ import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
2
+ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
3
+ //#region src/api-model/configuration.d.ts
4
+ /**
5
+ * Selling Partner API for Finances
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ interface AWSv4Configuration {
16
+ options?: {
17
+ region?: string;
18
+ service?: string;
19
+ };
20
+ credentials?: {
21
+ accessKeyId?: string;
22
+ secretAccessKey?: string;
23
+ sessionToken?: string;
24
+ };
25
+ }
26
+ interface ConfigurationParameters {
27
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
+ username?: string;
29
+ password?: string;
30
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
31
+ awsv4?: AWSv4Configuration;
32
+ basePath?: string;
33
+ serverIndex?: number;
34
+ baseOptions?: any;
35
+ formDataCtor?: new () => any;
36
+ }
37
+ declare class Configuration {
38
+ /**
39
+ * parameter for apiKey security
40
+ * @param name security name
41
+ */
42
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
43
+ /**
44
+ * parameter for basic security
45
+ */
46
+ username?: string;
47
+ /**
48
+ * parameter for basic security
49
+ */
50
+ password?: string;
51
+ /**
52
+ * parameter for oauth2 security
53
+ * @param name security name
54
+ * @param scopes oauth2 scope
55
+ */
56
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
57
+ /**
58
+ * parameter for aws4 signature security
59
+ * @param {Object} AWS4Signature - AWS4 Signature security
60
+ * @param {string} options.region - aws region
61
+ * @param {string} options.service - name of the service.
62
+ * @param {string} credentials.accessKeyId - aws access key id
63
+ * @param {string} credentials.secretAccessKey - aws access key
64
+ * @param {string} credentials.sessionToken - aws session token
65
+ * @memberof Configuration
66
+ */
67
+ awsv4?: AWSv4Configuration;
68
+ /**
69
+ * override base path
70
+ */
71
+ basePath?: string;
72
+ /**
73
+ * override server index
74
+ */
75
+ serverIndex?: number;
76
+ /**
77
+ * base options for axios calls
78
+ */
79
+ baseOptions?: any;
80
+ /**
81
+ * The FormData constructor that will be used to create multipart form data
82
+ * requests. You can inject this here so that execution environments that
83
+ * do not support the FormData class can still run the generated client.
84
+ *
85
+ * @type {new () => FormData}
86
+ */
87
+ formDataCtor?: new () => any;
88
+ constructor(param?: ConfigurationParameters);
89
+ /**
90
+ * Check if the given MIME is a JSON MIME.
91
+ * JSON MIME examples:
92
+ * application/json
93
+ * application/json; charset=UTF8
94
+ * APPLICATION/JSON
95
+ * application/vnd.company+json
96
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
97
+ * @return True if the given MIME is JSON, false otherwise.
98
+ */
99
+ isJsonMime(mime: string): boolean;
100
+ }
101
+ //#endregion
102
+ //#region src/api-model/base.d.ts
103
+ interface RequestArgs {
104
+ url: string;
105
+ options: RawAxiosRequestConfig;
106
+ }
107
+ declare class BaseAPI {
108
+ protected basePath: string;
109
+ protected axios: AxiosInstance;
110
+ protected configuration: Configuration | undefined;
111
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
112
+ }
113
+ //#endregion
114
+ //#region src/api-model/models/currency.d.ts
115
+ /**
116
+ * Selling Partner API for Finances
117
+ * 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.
118
+ *
119
+ * The version of the OpenAPI document: v0
120
+ *
121
+ *
122
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
123
+ * https://openapi-generator.tech
124
+ * Do not edit the class manually.
125
+ */
126
+ /**
127
+ * A currency type and amount.
128
+ */
129
+ interface Currency {
130
+ /**
131
+ * The three-digit currency code in ISO 4217 format.
132
+ */
133
+ 'CurrencyCode'?: string;
134
+ /**
135
+ * A signed decimal number.
136
+ */
137
+ 'CurrencyAmount'?: number;
138
+ }
139
+ //#endregion
140
+ //#region src/api-model/models/adhoc-disbursement-event.d.ts
141
+ /**
142
+ * An event related to an Adhoc Disbursement.
143
+ */
144
+ interface AdhocDisbursementEvent {
145
+ /**
146
+ * The type of transaction. For example, \"Disbursed to Amazon Gift Card balance\".
147
+ */
148
+ 'TransactionType'?: string;
149
+ /**
150
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
151
+ */
152
+ 'PostedDate'?: string;
153
+ /**
154
+ * The identifier for the transaction.
155
+ */
156
+ 'TransactionId'?: string;
157
+ 'TransactionAmount'?: Currency;
158
+ }
159
+ //#endregion
160
+ //#region src/api-model/models/adjustment-item.d.ts
161
+ /**
162
+ * An item in an adjustment to the seller\'s account.
163
+ */
164
+ interface AdjustmentItem {
165
+ /**
166
+ * Represents the number of units in the seller\'s inventory when the `AdjustmentType` is `FBAInventoryReimbursement`.
167
+ */
168
+ 'Quantity'?: string;
169
+ 'PerUnitAmount'?: Currency;
170
+ 'TotalAmount'?: Currency;
171
+ /**
172
+ * 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.
173
+ */
174
+ 'SellerSKU'?: string;
175
+ /**
176
+ * A unique identifier assigned to products stored in and fulfilled from a fulfillment center.
177
+ */
178
+ 'FnSKU'?: string;
179
+ /**
180
+ * A short description of the item.
181
+ */
182
+ 'ProductDescription'?: string;
183
+ /**
184
+ * The Amazon Standard Identification Number (ASIN) of the item.
185
+ */
186
+ 'ASIN'?: string;
187
+ /**
188
+ * The transaction number that is related to the adjustment.
189
+ */
190
+ 'TransactionNumber'?: string;
191
+ }
192
+ //#endregion
193
+ //#region src/api-model/models/adjustment-event.d.ts
194
+ /**
195
+ * An adjustment to the seller\'s account.
196
+ */
197
+ interface AdjustmentEvent {
198
+ /**
199
+ * 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 a settlement period closes. 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.
200
+ */
201
+ 'AdjustmentType'?: string;
202
+ /**
203
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
204
+ */
205
+ 'PostedDate'?: string;
206
+ /**
207
+ * The name of the store where the event occurred.
208
+ */
209
+ 'StoreName'?: string;
210
+ 'AdjustmentAmount'?: Currency;
211
+ /**
212
+ * A list of information about items in an adjustment to the seller\'s account.
213
+ */
214
+ 'AdjustmentItemList'?: Array<AdjustmentItem>;
215
+ }
216
+ //#endregion
217
+ //#region src/api-model/models/affordability-expense-event.d.ts
218
+ /**
219
+ * An expense related to an affordability promotion.
220
+ */
221
+ interface AffordabilityExpenseEvent {
222
+ /**
223
+ * An Amazon-defined identifier for an order.
224
+ */
225
+ 'AmazonOrderId'?: string;
226
+ /**
227
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
228
+ */
229
+ 'PostedDate'?: string;
230
+ /**
231
+ * The Amazon-defined marketplace identifier.
232
+ */
233
+ 'MarketplaceId'?: string;
234
+ /**
235
+ * The type of transaction. Possible values: * `Charge`: an affordability promotion expense. * `Refund`: an affordability promotion expense reversal.
236
+ */
237
+ 'TransactionType'?: string;
238
+ 'BaseExpense'?: Currency;
239
+ 'TaxTypeCGST': Currency;
240
+ 'TaxTypeSGST': Currency;
241
+ 'TaxTypeIGST': Currency;
242
+ 'TotalExpense'?: Currency;
243
+ }
244
+ //#endregion
245
+ //#region src/api-model/models/capacity-reservation-billing-event.d.ts
246
+ /**
247
+ * An event related to a capacity reservation billing charge.
248
+ */
249
+ interface CapacityReservationBillingEvent {
250
+ /**
251
+ * The transaction type. For example, FBA Inventory Fee.
252
+ */
253
+ 'TransactionType'?: string;
254
+ /**
255
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
256
+ */
257
+ 'PostedDate'?: string;
258
+ /**
259
+ * A short description of the capacity reservation billing event.
260
+ */
261
+ 'Description'?: string;
262
+ 'TransactionAmount'?: Currency;
263
+ }
264
+ //#endregion
265
+ //#region src/api-model/models/charge-component.d.ts
266
+ /**
267
+ * 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). * `PaidthroughEBT`: The amount of money paid with EBT for any order or shipment items.
268
+ */
269
+ interface ChargeComponent {
270
+ /**
271
+ * The type of charge.
272
+ */
273
+ 'ChargeType'?: string;
274
+ 'ChargeAmount'?: Currency;
275
+ }
276
+ //#endregion
277
+ //#region src/api-model/models/charge-instrument.d.ts
278
+ /**
279
+ * A payment instrument.
280
+ */
281
+ interface ChargeInstrument {
282
+ /**
283
+ * A short description of the charge instrument.
284
+ */
285
+ 'Description'?: string;
286
+ /**
287
+ * The account tail (trailing digits) of the charge instrument.
288
+ */
289
+ 'Tail'?: string;
290
+ 'Amount'?: Currency;
291
+ }
292
+ //#endregion
293
+ //#region src/api-model/models/charge-refund-transaction.d.ts
294
+ /**
295
+ * The charge refund transaction.
296
+ */
297
+ interface ChargeRefundTransaction {
298
+ 'ChargeAmount'?: Currency;
299
+ /**
300
+ * The type of charge.
301
+ */
302
+ 'ChargeType'?: string;
303
+ }
304
+ //#endregion
305
+ //#region src/api-model/models/charge-refund-event.d.ts
306
+ /**
307
+ * An event related to charge refund.
308
+ */
309
+ interface ChargeRefundEvent {
310
+ /**
311
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
312
+ */
313
+ 'PostedDate'?: string;
314
+ /**
315
+ * The reason given for a charge refund. For example, `SubscriptionFeeCorrection`.
316
+ */
317
+ 'ReasonCode'?: string;
318
+ /**
319
+ * A description of the Reason Code. For example, `SubscriptionFeeCorrection`.
320
+ */
321
+ 'ReasonCodeDescription'?: string;
322
+ /**
323
+ * A list of `ChargeRefund` transactions
324
+ */
325
+ 'ChargeRefundTransactions'?: Array<ChargeRefundTransaction>;
326
+ }
327
+ //#endregion
328
+ //#region src/api-model/models/fee-component.d.ts
329
+ /**
330
+ * A fee associated with the event.
331
+ */
332
+ interface FeeComponent {
333
+ /**
334
+ * 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.
335
+ */
336
+ 'FeeType'?: string;
337
+ 'FeeAmount'?: Currency;
338
+ }
339
+ //#endregion
340
+ //#region src/api-model/models/coupon-payment-event.d.ts
341
+ /**
342
+ * An event related to coupon payments.
343
+ */
344
+ interface CouponPaymentEvent {
345
+ /**
346
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
347
+ */
348
+ 'PostedDate'?: string;
349
+ /**
350
+ * A coupon identifier.
351
+ */
352
+ 'CouponId'?: string;
353
+ /**
354
+ * The description provided by the seller when they created the coupon.
355
+ */
356
+ 'SellerCouponDescription'?: string;
357
+ /**
358
+ * The number of coupon clips or redemptions.
359
+ */
360
+ 'ClipOrRedemptionCount'?: number;
361
+ /**
362
+ * A payment event identifier.
363
+ */
364
+ 'PaymentEventId'?: string;
365
+ 'FeeComponent'?: FeeComponent;
366
+ 'ChargeComponent'?: ChargeComponent;
367
+ 'TotalAmount'?: Currency;
368
+ }
369
+ //#endregion
370
+ //#region src/api-model/models/debt-recovery-item.d.ts
371
+ /**
372
+ * An item of a debt payment or debt adjustment.
373
+ */
374
+ interface DebtRecoveryItem {
375
+ 'RecoveryAmount'?: Currency;
376
+ 'OriginalAmount'?: Currency;
377
+ /**
378
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
379
+ */
380
+ 'GroupBeginDate'?: string;
381
+ /**
382
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
383
+ */
384
+ 'GroupEndDate'?: string;
385
+ }
386
+ //#endregion
387
+ //#region src/api-model/models/debt-recovery-event.d.ts
388
+ /**
389
+ * A debt payment or debt adjustment.
390
+ */
391
+ interface DebtRecoveryEvent {
392
+ /**
393
+ * The debt recovery type. Possible values: * `DebtPayment` * `DebtPaymentFailure` * `DebtAdjustment`
394
+ */
395
+ 'DebtRecoveryType'?: string;
396
+ 'RecoveryAmount'?: Currency;
397
+ 'OverPaymentCredit'?: Currency;
398
+ /**
399
+ * A list of debt recovery item information.
400
+ */
401
+ 'DebtRecoveryItemList'?: Array<DebtRecoveryItem>;
402
+ /**
403
+ * A list of payment instruments.
404
+ */
405
+ 'ChargeInstrumentList'?: Array<ChargeInstrument>;
406
+ }
407
+ //#endregion
408
+ //#region src/api-model/models/direct-payment.d.ts
409
+ /**
410
+ * A payment made directly to a seller.
411
+ */
412
+ interface DirectPayment {
413
+ /**
414
+ * 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.
415
+ */
416
+ 'DirectPaymentType'?: string;
417
+ 'DirectPaymentAmount'?: Currency;
418
+ }
419
+ //#endregion
420
+ //#region src/api-model/models/ebtrefund-reimbursement-only-event.d.ts
421
+ /**
422
+ * An EBT refund reimbursement event.
423
+ */
424
+ interface EBTRefundReimbursementOnlyEvent {
425
+ /**
426
+ * The identifier of an order.
427
+ */
428
+ 'OrderId'?: string;
429
+ /**
430
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
431
+ */
432
+ 'PostedDate'?: string;
433
+ 'Amount'?: Currency;
434
+ }
435
+ //#endregion
436
+ //#region src/api-model/models/fbaliquidation-event.d.ts
437
+ /**
438
+ * A payment event for Fulfillment by Amazon (FBA) inventory liquidation. This event is used only in the US marketplace.
439
+ */
440
+ interface FBALiquidationEvent {
441
+ /**
442
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
443
+ */
444
+ 'PostedDate'?: string;
445
+ /**
446
+ * The identifier for the original removal order.
447
+ */
448
+ 'OriginalRemovalOrderId'?: string;
449
+ 'LiquidationProceedsAmount'?: Currency;
450
+ 'LiquidationFeeAmount'?: Currency;
451
+ }
452
+ //#endregion
453
+ //#region src/api-model/models/failed-adhoc-disbursement-event.d.ts
454
+ /**
455
+ * Failed ad hoc disbursement event list.
456
+ */
457
+ interface FailedAdhocDisbursementEvent {
458
+ /**
459
+ * The type of fund transfer. For example, `Refund`.
460
+ */
461
+ 'FundsTransfersType'?: string;
462
+ /**
463
+ * The transfer identifier.
464
+ */
465
+ 'TransferId'?: string;
466
+ /**
467
+ * The disbursement identifier.
468
+ */
469
+ 'DisbursementId'?: string;
470
+ /**
471
+ * The type of payment for disbursement. For example, `CREDIT_CARD`.
472
+ */
473
+ 'PaymentDisbursementType'?: string;
474
+ /**
475
+ * The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`.
476
+ */
477
+ 'Status'?: string;
478
+ 'TransferAmount'?: Currency;
479
+ /**
480
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
481
+ */
482
+ 'PostedDate'?: string;
483
+ }
484
+ //#endregion
485
+ //#region src/api-model/models/financial-event-group.d.ts
486
+ /**
487
+ * Information related to a financial event group.
488
+ */
489
+ interface FinancialEventGroup {
490
+ /**
491
+ * A unique identifier for the financial event group.
492
+ */
493
+ 'FinancialEventGroupId'?: string;
494
+ /**
495
+ * The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: * `Open` * `Closed`
496
+ */
497
+ 'ProcessingStatus'?: string;
498
+ /**
499
+ * The status of the fund transfer.
500
+ */
501
+ 'FundTransferStatus'?: string;
502
+ 'OriginalTotal'?: Currency;
503
+ 'ConvertedTotal'?: Currency;
504
+ /**
505
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
506
+ */
507
+ 'FundTransferDate'?: string;
508
+ /**
509
+ * The trace identifier used by sellers to look up transactions externally.
510
+ */
511
+ 'TraceId'?: string;
512
+ /**
513
+ * The account tail of the payment instrument.
514
+ */
515
+ 'AccountTail'?: string;
516
+ 'BeginningBalance'?: Currency;
517
+ /**
518
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
519
+ */
520
+ 'FinancialEventGroupStart'?: string;
521
+ /**
522
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
523
+ */
524
+ 'FinancialEventGroupEnd'?: string;
525
+ }
526
+ //#endregion
527
+ //#region src/api-model/models/imaging-services-fee-event.d.ts
528
+ /**
529
+ * A fee event related to Amazon Imaging services.
530
+ */
531
+ interface ImagingServicesFeeEvent {
532
+ /**
533
+ * The identifier for the imaging services request.
534
+ */
535
+ 'ImagingRequestBillingItemID'?: string;
536
+ /**
537
+ * The Amazon Standard Identification Number (ASIN) of the item for which the imaging service was requested.
538
+ */
539
+ 'ASIN'?: string;
540
+ /**
541
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
542
+ */
543
+ 'PostedDate'?: string;
544
+ /**
545
+ * A list of fee component information.
546
+ */
547
+ 'FeeList'?: Array<FeeComponent>;
548
+ }
549
+ //#endregion
550
+ //#region src/api-model/models/loan-servicing-event.d.ts
551
+ /**
552
+ * A loan advance, loan payment, or loan refund.
553
+ */
554
+ interface LoanServicingEvent {
555
+ 'LoanAmount'?: Currency;
556
+ /**
557
+ * The type of event. Possible values: * `LoanAdvance` * `LoanPayment` * `LoanRefund`
558
+ */
559
+ 'SourceBusinessEventType'?: string;
560
+ }
561
+ //#endregion
562
+ //#region src/api-model/models/network-commingling-transaction-event.d.ts
563
+ /**
564
+ * A network commingling transaction event.
565
+ */
566
+ interface NetworkComminglingTransactionEvent {
567
+ /**
568
+ * 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.
569
+ */
570
+ 'TransactionType'?: string;
571
+ /**
572
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
573
+ */
574
+ 'PostedDate'?: string;
575
+ /**
576
+ * The identifier for the network item swap.
577
+ */
578
+ 'NetCoTransactionID'?: string;
579
+ /**
580
+ * The reason for the network item swap.
581
+ */
582
+ 'SwapReason'?: string;
583
+ /**
584
+ * The Amazon Standard Identification Number (ASIN) of the swapped item.
585
+ */
586
+ 'ASIN'?: string;
587
+ /**
588
+ * The marketplace in which the event took place.
589
+ */
590
+ 'MarketplaceId'?: string;
591
+ 'TaxExclusiveAmount'?: Currency;
592
+ 'TaxAmount'?: Currency;
593
+ }
594
+ //#endregion
595
+ //#region src/api-model/models/pay-with-amazon-event.d.ts
596
+ /**
597
+ * An event related to the seller\'s Pay with Amazon account.
598
+ */
599
+ interface PayWithAmazonEvent {
600
+ /**
601
+ * An order identifier that is specified by the seller.
602
+ */
603
+ 'SellerOrderId'?: string;
604
+ /**
605
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
606
+ */
607
+ 'TransactionPostedDate'?: string;
608
+ /**
609
+ * The type of business object.
610
+ */
611
+ 'BusinessObjectType'?: string;
612
+ /**
613
+ * The sales channel for the transaction.
614
+ */
615
+ 'SalesChannel'?: string;
616
+ 'Charge'?: ChargeComponent;
617
+ /**
618
+ * A list of fee component information.
619
+ */
620
+ 'FeeList'?: Array<FeeComponent>;
621
+ /**
622
+ * The type of payment. Possible values: * `Sales`
623
+ */
624
+ 'PaymentAmountType'?: string;
625
+ /**
626
+ * A short description of this payment event.
627
+ */
628
+ 'AmountDescription'?: string;
629
+ /**
630
+ * The fulfillment channel. Possible values: * `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon) * `MFN`: Merchant Fulfillment Network (self-fulfilled)
631
+ */
632
+ 'FulfillmentChannel'?: string;
633
+ /**
634
+ * The name of the store where the event occurred.
635
+ */
636
+ 'StoreName'?: string;
637
+ }
638
+ //#endregion
639
+ //#region src/api-model/models/product-ads-payment-event.d.ts
640
+ /**
641
+ * A Sponsored Products payment event.
642
+ */
643
+ interface ProductAdsPaymentEvent {
644
+ /**
645
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
646
+ */
647
+ 'postedDate'?: string;
648
+ /**
649
+ * Indicates if the transaction is for a charge or a refund. Possible values: * `charge` * `refund`
650
+ */
651
+ 'transactionType'?: string;
652
+ /**
653
+ * The identifier for the invoice that includes the transaction.
654
+ */
655
+ 'invoiceId'?: string;
656
+ 'baseValue'?: Currency;
657
+ 'taxValue'?: Currency;
658
+ 'transactionValue'?: Currency;
659
+ }
660
+ //#endregion
661
+ //#region src/api-model/models/removal-shipment-item-adjustment.d.ts
662
+ /**
663
+ * Item-level information for a removal shipment item adjustment.
664
+ */
665
+ interface RemovalShipmentItemAdjustment {
666
+ /**
667
+ * An identifier for an item in a removal shipment.
668
+ */
669
+ 'RemovalShipmentItemId'?: string;
670
+ /**
671
+ * The tax collection model that is 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.
672
+ */
673
+ 'TaxCollectionModel'?: string;
674
+ /**
675
+ * The Amazon fulfillment network SKU for the item.
676
+ */
677
+ 'FulfillmentNetworkSKU'?: string;
678
+ /**
679
+ * Adjusted quantity of `RemovalShipmentItemAdjustment` items.
680
+ */
681
+ 'AdjustedQuantity'?: number;
682
+ 'RevenueAdjustment'?: Currency;
683
+ 'TaxAmountAdjustment'?: Currency;
684
+ 'TaxWithheldAdjustment'?: Currency;
685
+ }
686
+ //#endregion
687
+ //#region src/api-model/models/removal-shipment-adjustment-event.d.ts
688
+ /**
689
+ * 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).
690
+ */
691
+ interface RemovalShipmentAdjustmentEvent {
692
+ /**
693
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
694
+ */
695
+ 'PostedDate'?: string;
696
+ /**
697
+ * The unique identifier for the adjustment event.
698
+ */
699
+ 'AdjustmentEventId'?: string;
700
+ /**
701
+ * The merchant removal orderId.
702
+ */
703
+ 'MerchantOrderId'?: string;
704
+ /**
705
+ * The orderId for shipping inventory.
706
+ */
707
+ 'OrderId'?: string;
708
+ /**
709
+ * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`.
710
+ */
711
+ 'TransactionType'?: string;
712
+ /**
713
+ * A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory.
714
+ */
715
+ 'RemovalShipmentItemAdjustmentList'?: Array<RemovalShipmentItemAdjustment>;
716
+ }
717
+ //#endregion
718
+ //#region src/api-model/models/removal-shipment-item.d.ts
719
+ /**
720
+ * Item-level information for a removal shipment.
721
+ */
722
+ interface RemovalShipmentItem {
723
+ /**
724
+ * An identifier for an item in a removal shipment.
725
+ */
726
+ 'RemovalShipmentItemId'?: string;
727
+ /**
728
+ * The tax collection model that is 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.
729
+ */
730
+ 'TaxCollectionModel'?: string;
731
+ /**
732
+ * The Amazon fulfillment network SKU for the item.
733
+ */
734
+ 'FulfillmentNetworkSKU'?: string;
735
+ /**
736
+ * The quantity of the item.
737
+ */
738
+ 'Quantity'?: number;
739
+ 'Revenue'?: Currency;
740
+ 'FeeAmount'?: Currency;
741
+ 'TaxAmount'?: Currency;
742
+ 'TaxWithheld'?: Currency;
743
+ }
744
+ //#endregion
745
+ //#region src/api-model/models/removal-shipment-event.d.ts
746
+ /**
747
+ * A removal shipment event for a removal order.
748
+ */
749
+ interface RemovalShipmentEvent {
750
+ /**
751
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
752
+ */
753
+ 'PostedDate'?: string;
754
+ /**
755
+ * The merchant removal `orderId`.
756
+ */
757
+ 'MerchantOrderId'?: string;
758
+ /**
759
+ * The identifier for the removal shipment order.
760
+ */
761
+ 'OrderId'?: string;
762
+ /**
763
+ * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`
764
+ */
765
+ 'TransactionType'?: string;
766
+ /**
767
+ * The name of the store where the event occurred.
768
+ */
769
+ 'StoreName'?: string;
770
+ /**
771
+ * A list of `RemovalShipmentItem`.
772
+ */
773
+ 'RemovalShipmentItemList'?: Array<RemovalShipmentItem>;
774
+ }
775
+ //#endregion
776
+ //#region src/api-model/models/tax-withheld-component.d.ts
777
+ /**
778
+ * Information about the taxes withheld.
779
+ */
780
+ interface TaxWithheldComponent {
781
+ /**
782
+ * 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.
783
+ */
784
+ 'TaxCollectionModel'?: string;
785
+ /**
786
+ * A list of charge information on the seller\'s account.
787
+ */
788
+ 'TaxesWithheld'?: Array<ChargeComponent>;
789
+ }
790
+ //#endregion
791
+ //#region src/api-model/models/rental-transaction-event.d.ts
792
+ /**
793
+ * An event related to a rental transaction.
794
+ */
795
+ interface RentalTransactionEvent {
796
+ /**
797
+ * An Amazon-defined identifier for an order.
798
+ */
799
+ 'AmazonOrderId'?: string;
800
+ /**
801
+ * The type of rental event. Possible values: * `RentalCustomerPayment-Buyout`: A transaction type that represents when the customer wants to buy out a rented item. * `RentalCustomerPayment-Extension`: A transaction type that represents when the customer wants to extend the rental period. * `RentalCustomerRefund-Buyout`: A transaction type that represents when the customer requests a refund for the buyout of the rented item. * `RentalCustomerRefund-Extension`: A transaction type that represents when the customer requests a refund over the extension on the rented item. * `RentalHandlingFee`: A transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * `RentalChargeFailureReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * `RentalLostItemReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a lost item.
802
+ */
803
+ 'RentalEventType'?: string;
804
+ /**
805
+ * The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events.
806
+ */
807
+ 'ExtensionLength'?: number;
808
+ /**
809
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
810
+ */
811
+ 'PostedDate'?: string;
812
+ /**
813
+ * A list of charge information on the seller\'s account.
814
+ */
815
+ 'RentalChargeList'?: Array<ChargeComponent>;
816
+ /**
817
+ * A list of fee component information.
818
+ */
819
+ 'RentalFeeList'?: Array<FeeComponent>;
820
+ /**
821
+ * The name of the marketplace.
822
+ */
823
+ 'MarketplaceName'?: string;
824
+ 'RentalInitialValue'?: Currency;
825
+ 'RentalReimbursement'?: Currency;
826
+ /**
827
+ * A list of information about taxes withheld.
828
+ */
829
+ 'RentalTaxWithheldList'?: Array<TaxWithheldComponent>;
830
+ }
831
+ //#endregion
832
+ //#region src/api-model/models/retrocharge-event.d.ts
833
+ /**
834
+ * A retrocharge or retrocharge reversal.
835
+ */
836
+ interface RetrochargeEvent {
837
+ /**
838
+ * The type of event. Possible values: * `Retrocharge` * `RetrochargeReversal`
839
+ */
840
+ 'RetrochargeEventType'?: string;
841
+ /**
842
+ * An Amazon-defined identifier for an order.
843
+ */
844
+ 'AmazonOrderId'?: string;
845
+ /**
846
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
847
+ */
848
+ 'PostedDate'?: string;
849
+ 'BaseTax'?: Currency;
850
+ 'ShippingTax'?: Currency;
851
+ /**
852
+ * The name of the marketplace where the retrocharge event occurred.
853
+ */
854
+ 'MarketplaceName'?: string;
855
+ /**
856
+ * A list of information about taxes withheld.
857
+ */
858
+ 'RetrochargeTaxWithheldList'?: Array<TaxWithheldComponent>;
859
+ }
860
+ //#endregion
861
+ //#region src/api-model/models/safetreimbursement-item.d.ts
862
+ /**
863
+ * An item from a SAFE-T claim reimbursement.
864
+ */
865
+ interface SAFETReimbursementItem {
866
+ /**
867
+ * A list of charge information on the seller\'s account.
868
+ */
869
+ 'itemChargeList'?: Array<ChargeComponent>;
870
+ /**
871
+ * The description of the item as shown on the product detail page on the retail website.
872
+ */
873
+ 'productDescription'?: string;
874
+ /**
875
+ * The number of units of the item being reimbursed.
876
+ */
877
+ 'quantity'?: string;
878
+ }
879
+ //#endregion
880
+ //#region src/api-model/models/safetreimbursement-event.d.ts
881
+ /**
882
+ * A SAFE-T claim reimbursement on the seller\'s account.
883
+ */
884
+ interface SAFETReimbursementEvent {
885
+ /**
886
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
887
+ */
888
+ 'PostedDate'?: string;
889
+ /**
890
+ * A SAFE-T claim identifier.
891
+ */
892
+ 'SAFETClaimId'?: string;
893
+ 'ReimbursedAmount'?: Currency;
894
+ /**
895
+ * Indicates why the seller was reimbursed.
896
+ */
897
+ 'ReasonCode'?: string;
898
+ /**
899
+ * A list of `SAFETReimbursementItem`.
900
+ */
901
+ 'SAFETReimbursementItemList'?: Array<SAFETReimbursementItem>;
902
+ }
903
+ //#endregion
904
+ //#region src/api-model/models/seller-deal-payment-event.d.ts
905
+ /**
906
+ * An event linked to the payment of a fee related to the specified deal.
907
+ */
908
+ interface SellerDealPaymentEvent {
909
+ /**
910
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
911
+ */
912
+ 'postedDate'?: string;
913
+ /**
914
+ * The unique identifier of the deal.
915
+ */
916
+ 'dealId'?: string;
917
+ /**
918
+ * The internal description of the deal.
919
+ */
920
+ 'dealDescription'?: string;
921
+ /**
922
+ * The type of event: `SellerDealComplete`.
923
+ */
924
+ 'eventType'?: string;
925
+ /**
926
+ * The type of fee: `RunLightningDealFee`.
927
+ */
928
+ 'feeType'?: string;
929
+ 'feeAmount'?: Currency;
930
+ 'taxAmount'?: Currency;
931
+ 'totalAmount'?: Currency;
932
+ }
933
+ //#endregion
934
+ //#region src/api-model/models/seller-review-enrollment-payment-event.d.ts
935
+ /**
936
+ * A fee payment event for the Early Reviewer Program.
937
+ */
938
+ interface SellerReviewEnrollmentPaymentEvent {
939
+ /**
940
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
941
+ */
942
+ 'PostedDate'?: string;
943
+ /**
944
+ * An enrollment identifier.
945
+ */
946
+ 'EnrollmentId'?: string;
947
+ /**
948
+ * The Amazon Standard Identification Number (ASIN) of the item that was enrolled in the Early Reviewer Program.
949
+ */
950
+ 'ParentASIN'?: string;
951
+ 'FeeComponent'?: FeeComponent;
952
+ 'ChargeComponent'?: ChargeComponent;
953
+ 'TotalAmount'?: Currency;
954
+ }
955
+ //#endregion
956
+ //#region src/api-model/models/service-fee-event.d.ts
957
+ /**
958
+ * A service fee on the seller\'s account.
959
+ */
960
+ interface ServiceFeeEvent {
961
+ /**
962
+ * An Amazon-defined identifier for an order.
963
+ */
964
+ 'AmazonOrderId'?: string;
965
+ /**
966
+ * A short description of the service fee reason.
967
+ */
968
+ 'FeeReason'?: string;
969
+ /**
970
+ * A list of fee component information.
971
+ */
972
+ 'FeeList'?: Array<FeeComponent>;
973
+ /**
974
+ * 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.
975
+ */
976
+ 'SellerSKU'?: string;
977
+ /**
978
+ * A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.
979
+ */
980
+ 'FnSKU'?: string;
981
+ /**
982
+ * A short description of the service fee event.
983
+ */
984
+ 'FeeDescription'?: string;
985
+ /**
986
+ * The Amazon Standard Identification Number (ASIN) of the item.
987
+ */
988
+ 'ASIN'?: string;
989
+ /**
990
+ * The name of the store where the event occurred.
991
+ */
992
+ 'StoreName'?: string;
993
+ }
994
+ //#endregion
995
+ //#region src/api-model/models/promotion.d.ts
996
+ /**
997
+ * A promotion applied to an item.
998
+ */
999
+ interface Promotion {
1000
+ /**
1001
+ * The type of promotion.
1002
+ */
1003
+ 'PromotionType'?: string;
1004
+ /**
1005
+ * The seller-specified identifier for the promotion.
1006
+ */
1007
+ 'PromotionId'?: string;
1008
+ 'PromotionAmount'?: Currency;
1009
+ }
1010
+ //#endregion
1011
+ //#region src/api-model/models/shipment-item.d.ts
1012
+ /**
1013
+ * An item of a shipment, refund, guarantee claim, or chargeback.
1014
+ */
1015
+ interface ShipmentItem {
1016
+ /**
1017
+ * 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.
1018
+ */
1019
+ 'SellerSKU'?: string;
1020
+ /**
1021
+ * An Amazon-defined order item identifier.
1022
+ */
1023
+ 'OrderItemId'?: string;
1024
+ /**
1025
+ * An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events.
1026
+ */
1027
+ 'OrderAdjustmentItemId'?: string;
1028
+ /**
1029
+ * The number of items shipped.
1030
+ */
1031
+ 'QuantityShipped'?: number;
1032
+ /**
1033
+ * A list of charge information on the seller\'s account.
1034
+ */
1035
+ 'ItemChargeList'?: Array<ChargeComponent>;
1036
+ /**
1037
+ * A list of charge information on the seller\'s account.
1038
+ */
1039
+ 'ItemChargeAdjustmentList'?: Array<ChargeComponent>;
1040
+ /**
1041
+ * A list of fee component information.
1042
+ */
1043
+ 'ItemFeeList'?: Array<FeeComponent>;
1044
+ /**
1045
+ * A list of fee component information.
1046
+ */
1047
+ 'ItemFeeAdjustmentList'?: Array<FeeComponent>;
1048
+ /**
1049
+ * A list of information about taxes withheld.
1050
+ */
1051
+ 'ItemTaxWithheldList'?: Array<TaxWithheldComponent>;
1052
+ /**
1053
+ * A list of promotions.
1054
+ */
1055
+ 'PromotionList'?: Array<Promotion>;
1056
+ /**
1057
+ * A list of promotions.
1058
+ */
1059
+ 'PromotionAdjustmentList'?: Array<Promotion>;
1060
+ 'CostOfPointsGranted'?: Currency;
1061
+ 'CostOfPointsReturned'?: Currency;
1062
+ }
1063
+ //#endregion
1064
+ //#region src/api-model/models/shipment-event.d.ts
1065
+ /**
1066
+ * A shipment, refund, guarantee claim, or chargeback.
1067
+ */
1068
+ interface ShipmentEvent {
1069
+ /**
1070
+ * An Amazon-defined identifier for an order.
1071
+ */
1072
+ 'AmazonOrderId'?: string;
1073
+ /**
1074
+ * A seller-defined identifier for an order.
1075
+ */
1076
+ 'SellerOrderId'?: string;
1077
+ /**
1078
+ * The name of the marketplace where the event occurred.
1079
+ */
1080
+ 'MarketplaceName'?: string;
1081
+ /**
1082
+ * The name of the store where the event occurred.
1083
+ */
1084
+ 'StoreName'?: string;
1085
+ /**
1086
+ * A list of charge information on the seller\'s account.
1087
+ */
1088
+ 'OrderChargeList'?: Array<ChargeComponent>;
1089
+ /**
1090
+ * A list of charge information on the seller\'s account.
1091
+ */
1092
+ 'OrderChargeAdjustmentList'?: Array<ChargeComponent>;
1093
+ /**
1094
+ * A list of fee component information.
1095
+ */
1096
+ 'ShipmentFeeList'?: Array<FeeComponent>;
1097
+ /**
1098
+ * A list of fee component information.
1099
+ */
1100
+ 'ShipmentFeeAdjustmentList'?: Array<FeeComponent>;
1101
+ /**
1102
+ * A list of fee component information.
1103
+ */
1104
+ 'OrderFeeList'?: Array<FeeComponent>;
1105
+ /**
1106
+ * A list of fee component information.
1107
+ */
1108
+ 'OrderFeeAdjustmentList'?: Array<FeeComponent>;
1109
+ /**
1110
+ * A list of direct payment information.
1111
+ */
1112
+ 'DirectPaymentList'?: Array<DirectPayment>;
1113
+ /**
1114
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1115
+ */
1116
+ 'PostedDate'?: string;
1117
+ /**
1118
+ * A list of shipment items.
1119
+ */
1120
+ 'ShipmentItemList'?: Array<ShipmentItem>;
1121
+ /**
1122
+ * A list of shipment items.
1123
+ */
1124
+ 'ShipmentItemAdjustmentList'?: Array<ShipmentItem>;
1125
+ }
1126
+ //#endregion
1127
+ //#region src/api-model/models/solution-provider-credit-event.d.ts
1128
+ /**
1129
+ * A credit given to a solution provider.
1130
+ */
1131
+ interface SolutionProviderCreditEvent {
1132
+ /**
1133
+ * The transaction type.
1134
+ */
1135
+ 'ProviderTransactionType'?: string;
1136
+ /**
1137
+ * A seller-defined identifier for an order.
1138
+ */
1139
+ 'SellerOrderId'?: string;
1140
+ /**
1141
+ * The identifier of the marketplace where the order was placed.
1142
+ */
1143
+ 'MarketplaceId'?: string;
1144
+ /**
1145
+ * The two-letter country code of the country associated with the marketplace where the order was placed.
1146
+ */
1147
+ 'MarketplaceCountryCode'?: string;
1148
+ /**
1149
+ * The Amazon-defined identifier of the seller.
1150
+ */
1151
+ 'SellerId'?: string;
1152
+ /**
1153
+ * The store name where the payment event occurred.
1154
+ */
1155
+ 'SellerStoreName'?: string;
1156
+ /**
1157
+ * The Amazon-defined identifier of the solution provider.
1158
+ */
1159
+ 'ProviderId'?: string;
1160
+ /**
1161
+ * The store name where the payment event occurred.
1162
+ */
1163
+ 'ProviderStoreName'?: string;
1164
+ 'TransactionAmount'?: Currency;
1165
+ /**
1166
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1167
+ */
1168
+ 'TransactionCreationDate'?: string;
1169
+ }
1170
+ //#endregion
1171
+ //#region src/api-model/models/tdsreimbursement-event.d.ts
1172
+ /**
1173
+ * An event related to a Tax-Deducted-at-Source (TDS) reimbursement.
1174
+ */
1175
+ interface TDSReimbursementEvent {
1176
+ /**
1177
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1178
+ */
1179
+ 'PostedDate'?: string;
1180
+ /**
1181
+ * The Tax-Deducted-at-Source (TDS) identifier.
1182
+ */
1183
+ 'TDSOrderId'?: string;
1184
+ 'ReimbursedAmount'?: Currency;
1185
+ }
1186
+ //#endregion
1187
+ //#region src/api-model/models/tax-withholding-period.d.ts
1188
+ /**
1189
+ * Selling Partner API for Finances
1190
+ * 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.
1191
+ *
1192
+ * The version of the OpenAPI document: v0
1193
+ *
1194
+ *
1195
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1196
+ * https://openapi-generator.tech
1197
+ * Do not edit the class manually.
1198
+ */
1199
+ /**
1200
+ * The period during which tax withholding on a seller\'s account is calculated.
1201
+ */
1202
+ interface TaxWithholdingPeriod {
1203
+ /**
1204
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1205
+ */
1206
+ 'StartDate'?: string;
1207
+ /**
1208
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1209
+ */
1210
+ 'EndDate'?: string;
1211
+ }
1212
+ //#endregion
1213
+ //#region src/api-model/models/tax-withholding-event.d.ts
1214
+ /**
1215
+ * A tax withholding event on a seller\'s account.
1216
+ */
1217
+ interface TaxWithholdingEvent {
1218
+ /**
1219
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1220
+ */
1221
+ 'PostedDate'?: string;
1222
+ 'BaseAmount'?: Currency;
1223
+ 'WithheldAmount'?: Currency;
1224
+ 'TaxWithholdingPeriod'?: TaxWithholdingPeriod;
1225
+ }
1226
+ //#endregion
1227
+ //#region src/api-model/models/trial-shipment-event.d.ts
1228
+ /**
1229
+ * An event related to a trial shipment.
1230
+ */
1231
+ interface TrialShipmentEvent {
1232
+ /**
1233
+ * An Amazon-defined identifier for an order.
1234
+ */
1235
+ 'AmazonOrderId'?: string;
1236
+ /**
1237
+ * The identifier of the financial event group.
1238
+ */
1239
+ 'FinancialEventGroupId'?: string;
1240
+ /**
1241
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1242
+ */
1243
+ 'PostedDate'?: string;
1244
+ /**
1245
+ * 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.
1246
+ */
1247
+ 'SKU'?: string;
1248
+ /**
1249
+ * A list of fee component information.
1250
+ */
1251
+ 'FeeList'?: Array<FeeComponent>;
1252
+ }
1253
+ //#endregion
1254
+ //#region src/api-model/models/value-added-service-charge-event.d.ts
1255
+ /**
1256
+ * An event related to a value added service charge.
1257
+ */
1258
+ interface ValueAddedServiceChargeEvent {
1259
+ /**
1260
+ * The transaction type. For example, \'Other Support Service fees\'
1261
+ */
1262
+ 'TransactionType'?: string;
1263
+ /**
1264
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1265
+ */
1266
+ 'PostedDate'?: string;
1267
+ /**
1268
+ * A short description of the service charge event.
1269
+ */
1270
+ 'Description'?: string;
1271
+ 'TransactionAmount'?: Currency;
1272
+ }
1273
+ //#endregion
1274
+ //#region src/api-model/models/financial-events.d.ts
1275
+ /**
1276
+ * All the information that is related to a financial event.
1277
+ */
1278
+ interface FinancialEvents {
1279
+ /**
1280
+ * A list of shipment event information.
1281
+ */
1282
+ 'ShipmentEventList'?: Array<ShipmentEvent>;
1283
+ /**
1284
+ * A list of `ShipmentEvent` items.
1285
+ */
1286
+ 'ShipmentSettleEventList'?: Array<ShipmentEvent>;
1287
+ /**
1288
+ * A list of shipment event information.
1289
+ */
1290
+ 'RefundEventList'?: Array<ShipmentEvent>;
1291
+ /**
1292
+ * A list of shipment event information.
1293
+ */
1294
+ 'GuaranteeClaimEventList'?: Array<ShipmentEvent>;
1295
+ /**
1296
+ * A list of EBT refund reimbursement events.
1297
+ */
1298
+ 'EBTRefundReimbursementOnlyEventList'?: Array<EBTRefundReimbursementOnlyEvent>;
1299
+ /**
1300
+ * A list of shipment event information.
1301
+ */
1302
+ 'ChargebackEventList'?: Array<ShipmentEvent>;
1303
+ /**
1304
+ * A list of events related to the seller\'s Pay with Amazon account.
1305
+ */
1306
+ 'PayWithAmazonEventList'?: Array<PayWithAmazonEvent>;
1307
+ /**
1308
+ * A list of `SolutionProviderCreditEvent`.
1309
+ */
1310
+ 'ServiceProviderCreditEventList'?: Array<SolutionProviderCreditEvent>;
1311
+ /**
1312
+ * A list of information about `Retrocharge` or `RetrochargeReversal` events.
1313
+ */
1314
+ 'RetrochargeEventList'?: Array<RetrochargeEvent>;
1315
+ /**
1316
+ * A list of rental transaction event information.
1317
+ */
1318
+ 'RentalTransactionEventList'?: Array<RentalTransactionEvent>;
1319
+ /**
1320
+ * A list of sponsored products payment events.
1321
+ */
1322
+ 'ProductAdsPaymentEventList'?: Array<ProductAdsPaymentEvent>;
1323
+ /**
1324
+ * A list of information about service fee events.
1325
+ */
1326
+ 'ServiceFeeEventList'?: Array<ServiceFeeEvent>;
1327
+ /**
1328
+ * A list of payment events for deal-related fees.
1329
+ */
1330
+ 'SellerDealPaymentEventList'?: Array<SellerDealPaymentEvent>;
1331
+ /**
1332
+ * A list of debt recovery event information.
1333
+ */
1334
+ 'DebtRecoveryEventList'?: Array<DebtRecoveryEvent>;
1335
+ /**
1336
+ * A list of loan servicing events.
1337
+ */
1338
+ 'LoanServicingEventList'?: Array<LoanServicingEvent>;
1339
+ /**
1340
+ * A list of adjustment event information for the seller\'s account.
1341
+ */
1342
+ 'AdjustmentEventList'?: Array<AdjustmentEvent>;
1343
+ /**
1344
+ * A list of `SAFETReimbursementEvent`.
1345
+ */
1346
+ 'SAFETReimbursementEventList'?: Array<SAFETReimbursementEvent>;
1347
+ /**
1348
+ * A list of information about fee events for the Early Reviewer Program.
1349
+ */
1350
+ 'SellerReviewEnrollmentPaymentEventList'?: Array<SellerReviewEnrollmentPaymentEvent>;
1351
+ /**
1352
+ * A list of FBA inventory liquidation payment events.
1353
+ */
1354
+ 'FBALiquidationEventList'?: Array<FBALiquidationEvent>;
1355
+ /**
1356
+ * A list of coupon payment event information.
1357
+ */
1358
+ 'CouponPaymentEventList'?: Array<CouponPaymentEvent>;
1359
+ /**
1360
+ * A list of fee events related to Amazon Imaging services.
1361
+ */
1362
+ 'ImagingServicesFeeEventList'?: Array<ImagingServicesFeeEvent>;
1363
+ /**
1364
+ * A list of network commingling transaction events.
1365
+ */
1366
+ 'NetworkComminglingTransactionEventList'?: Array<NetworkComminglingTransactionEvent>;
1367
+ /**
1368
+ * A list of expense information related to an affordability promotion.
1369
+ */
1370
+ 'AffordabilityExpenseEventList'?: Array<AffordabilityExpenseEvent>;
1371
+ /**
1372
+ * A list of expense information related to an affordability promotion.
1373
+ */
1374
+ 'AffordabilityExpenseReversalEventList'?: Array<AffordabilityExpenseEvent>;
1375
+ /**
1376
+ * A list of removal shipment event information.
1377
+ */
1378
+ 'RemovalShipmentEventList'?: Array<RemovalShipmentEvent>;
1379
+ /**
1380
+ * A comma-delimited list of `RemovalShipmentAdjustment` details for FBA inventory.
1381
+ */
1382
+ 'RemovalShipmentAdjustmentEventList'?: Array<RemovalShipmentAdjustmentEvent>;
1383
+ /**
1384
+ * A list of information about trial shipment financial events.
1385
+ */
1386
+ 'TrialShipmentEventList'?: Array<TrialShipmentEvent>;
1387
+ /**
1388
+ * A list of `TDSReimbursementEvent` items.
1389
+ */
1390
+ 'TDSReimbursementEventList'?: Array<TDSReimbursementEvent>;
1391
+ /**
1392
+ * A list of `AdhocDisbursement` events.
1393
+ */
1394
+ 'AdhocDisbursementEventList'?: Array<AdhocDisbursementEvent>;
1395
+ /**
1396
+ * A list of tax withholding events.
1397
+ */
1398
+ 'TaxWithholdingEventList'?: Array<TaxWithholdingEvent>;
1399
+ /**
1400
+ * A list of charge refund events.
1401
+ */
1402
+ 'ChargeRefundEventList'?: Array<ChargeRefundEvent>;
1403
+ /**
1404
+ * A list of `FailedAdhocDisbursementEvent`.
1405
+ */
1406
+ 'FailedAdhocDisbursementEventList'?: Array<FailedAdhocDisbursementEvent>;
1407
+ /**
1408
+ * A list of `ValueAddedServiceCharge` events.
1409
+ */
1410
+ 'ValueAddedServiceChargeEventList'?: Array<ValueAddedServiceChargeEvent>;
1411
+ /**
1412
+ * A list of `CapacityReservationBillingEvent` events.
1413
+ */
1414
+ 'CapacityReservationBillingEventList'?: Array<CapacityReservationBillingEvent>;
1415
+ }
1416
+ //#endregion
1417
+ //#region src/api-model/models/list-financial-event-groups-payload.d.ts
1418
+ /**
1419
+ * The payload for the `listFinancialEventGroups` operation.
1420
+ */
1421
+ interface ListFinancialEventGroupsPayload {
1422
+ /**
1423
+ * When present and not empty, pass this string token in the next request to return the next response page.
1424
+ */
1425
+ 'NextToken'?: string;
1426
+ /**
1427
+ * A list of financial event group information.
1428
+ */
1429
+ 'FinancialEventGroupList'?: Array<FinancialEventGroup>;
1430
+ }
1431
+ //#endregion
1432
+ //#region src/api-model/models/list-financial-event-groups-response.d.ts
1433
+ /**
1434
+ * The response schema for the `listFinancialEventGroups` operation.
1435
+ */
1436
+ interface ListFinancialEventGroupsResponse {
1437
+ 'payload'?: ListFinancialEventGroupsPayload;
1438
+ /**
1439
+ * A list of error responses returned when a request is unsuccessful.
1440
+ */
1441
+ 'errors'?: Array<Error>;
1442
+ }
1443
+ //#endregion
1444
+ //#region src/api-model/models/list-financial-events-payload.d.ts
1445
+ /**
1446
+ * The payload for the `listFinancialEvents` operation.
1447
+ */
1448
+ interface ListFinancialEventsPayload {
1449
+ /**
1450
+ * When present and not empty, pass this string token in the next request to return the next response page.
1451
+ */
1452
+ 'NextToken'?: string;
1453
+ 'FinancialEvents'?: FinancialEvents;
1454
+ }
1455
+ //#endregion
1456
+ //#region src/api-model/models/list-financial-events-response.d.ts
1457
+ /**
1458
+ * The response schema for the `listFinancialEvents` operation.
1459
+ */
1460
+ interface ListFinancialEventsResponse {
1461
+ 'payload'?: ListFinancialEventsPayload;
1462
+ /**
1463
+ * A list of error responses returned when a request is unsuccessful.
1464
+ */
1465
+ 'errors'?: Array<Error>;
1466
+ }
1467
+ //#endregion
1468
+ //#region src/api-model/models/model-error.d.ts
1469
+ /**
1470
+ * Selling Partner API for Finances
1471
+ * 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.
1472
+ *
1473
+ * The version of the OpenAPI document: v0
1474
+ *
1475
+ *
1476
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1477
+ * https://openapi-generator.tech
1478
+ * Do not edit the class manually.
1479
+ */
1480
+ /**
1481
+ * Error response returned when the request is unsuccessful.
1482
+ */
1483
+ interface ModelError {
1484
+ /**
1485
+ * An error code that identifies the type of error that occurred.
1486
+ */
1487
+ 'code': string;
1488
+ /**
1489
+ * A message that describes the error condition in a human-readable form.
1490
+ */
1491
+ 'message': string;
1492
+ /**
1493
+ * Additional details that can help the caller understand or fix the issue.
1494
+ */
1495
+ 'details'?: string;
1496
+ }
1497
+ //#endregion
1498
+ //#region src/api-model/api/finances-api.d.ts
1499
+ /**
1500
+ * FinancesApi - axios parameter creator
1501
+ */
1502
+ declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
1503
+ /**
1504
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1505
+ * @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1506
+ * @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after &#x60;FinancialEventGroupStartedAfter&#x60; and more than two minutes before the time of request. If &#x60;FinancialEventGroupStartedAfter&#x60; and &#x60;FinancialEventGroupStartedBefore&#x60; are more than 180 days apart, no financial event groups are returned.
1507
+ * @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
1508
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1509
+ * @param {*} [options] Override http request option.
1510
+ * @throws {RequiredError}
1511
+ */
1512
+ listFinancialEventGroups: (maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1513
+ /**
1514
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1515
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1516
+ * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
1517
+ * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. If you include the &#x60;PostedBefore&#x60; parameter in your request, you must also specify the &#x60;PostedAfter&#x60; parameter. **Default:** Two minutes before the time of the request.
1518
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1519
+ * @param {*} [options] Override http request option.
1520
+ * @throws {RequiredError}
1521
+ */
1522
+ listFinancialEvents: (maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1523
+ /**
1524
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1525
+ * @param {string} eventGroupId The identifier of the financial event group to which the events belong.
1526
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1527
+ * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
1528
+ * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. If you include the &#x60;PostedBefore&#x60; parameter in your request, you must also specify the &#x60;PostedAfter&#x60; parameter. **Default:** Two minutes before the time of the request.
1529
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1530
+ * @param {*} [options] Override http request option.
1531
+ * @throws {RequiredError}
1532
+ */
1533
+ listFinancialEventsByGroupId: (eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1534
+ /**
1535
+ * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1536
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
1537
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1538
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1539
+ * @param {*} [options] Override http request option.
1540
+ * @throws {RequiredError}
1541
+ */
1542
+ listFinancialEventsByOrderId: (orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1543
+ };
1544
+ /**
1545
+ * FinancesApi - functional programming interface
1546
+ */
1547
+ declare const FinancesApiFp: (configuration?: Configuration) => {
1548
+ /**
1549
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1550
+ * @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1551
+ * @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after &#x60;FinancialEventGroupStartedAfter&#x60; and more than two minutes before the time of request. If &#x60;FinancialEventGroupStartedAfter&#x60; and &#x60;FinancialEventGroupStartedBefore&#x60; are more than 180 days apart, no financial event groups are returned.
1552
+ * @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
1553
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1554
+ * @param {*} [options] Override http request option.
1555
+ * @throws {RequiredError}
1556
+ */
1557
+ listFinancialEventGroups(maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventGroupsResponse>>;
1558
+ /**
1559
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1560
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1561
+ * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
1562
+ * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. If you include the &#x60;PostedBefore&#x60; parameter in your request, you must also specify the &#x60;PostedAfter&#x60; parameter. **Default:** Two minutes before the time of the request.
1563
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1564
+ * @param {*} [options] Override http request option.
1565
+ * @throws {RequiredError}
1566
+ */
1567
+ listFinancialEvents(maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
1568
+ /**
1569
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1570
+ * @param {string} eventGroupId The identifier of the financial event group to which the events belong.
1571
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1572
+ * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
1573
+ * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. If you include the &#x60;PostedBefore&#x60; parameter in your request, you must also specify the &#x60;PostedAfter&#x60; parameter. **Default:** Two minutes before the time of the request.
1574
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1575
+ * @param {*} [options] Override http request option.
1576
+ * @throws {RequiredError}
1577
+ */
1578
+ listFinancialEventsByGroupId(eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
1579
+ /**
1580
+ * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1581
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
1582
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1583
+ * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1584
+ * @param {*} [options] Override http request option.
1585
+ * @throws {RequiredError}
1586
+ */
1587
+ listFinancialEventsByOrderId(orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
1588
+ };
1589
+ /**
1590
+ * FinancesApi - factory interface
1591
+ */
1592
+ declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1593
+ /**
1594
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1595
+ * @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
1596
+ * @param {*} [options] Override http request option.
1597
+ * @throws {RequiredError}
1598
+ */
1599
+ listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventGroupsResponse>;
1600
+ /**
1601
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1602
+ * @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
1603
+ * @param {*} [options] Override http request option.
1604
+ * @throws {RequiredError}
1605
+ */
1606
+ listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
1607
+ /**
1608
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1609
+ * @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
1610
+ * @param {*} [options] Override http request option.
1611
+ * @throws {RequiredError}
1612
+ */
1613
+ listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
1614
+ /**
1615
+ * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1616
+ * @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
1617
+ * @param {*} [options] Override http request option.
1618
+ * @throws {RequiredError}
1619
+ */
1620
+ listFinancialEventsByOrderId(requestParameters: FinancesApiListFinancialEventsByOrderIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
1621
+ };
1622
+ /**
1623
+ * Request parameters for listFinancialEventGroups operation in FinancesApi.
1624
+ */
1625
+ interface FinancesApiListFinancialEventGroupsRequest {
1626
+ /**
1627
+ * The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1628
+ */
1629
+ readonly maxResultsPerPage?: number;
1630
+ /**
1631
+ * A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after &#x60;FinancialEventGroupStartedAfter&#x60; and more than two minutes before the time of request. If &#x60;FinancialEventGroupStartedAfter&#x60; and &#x60;FinancialEventGroupStartedBefore&#x60; are more than 180 days apart, no financial event groups are returned.
1632
+ */
1633
+ readonly financialEventGroupStartedBefore?: string;
1634
+ /**
1635
+ * A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
1636
+ */
1637
+ readonly financialEventGroupStartedAfter?: string;
1638
+ /**
1639
+ * The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1640
+ */
1641
+ readonly nextToken?: string;
1642
+ }
1643
+ /**
1644
+ * Request parameters for listFinancialEvents operation in FinancesApi.
1645
+ */
1646
+ interface FinancesApiListFinancialEventsRequest {
1647
+ /**
1648
+ * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1649
+ */
1650
+ readonly maxResultsPerPage?: number;
1651
+ /**
1652
+ * The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
1653
+ */
1654
+ readonly postedAfter?: string;
1655
+ /**
1656
+ * The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. If you include the &#x60;PostedBefore&#x60; parameter in your request, you must also specify the &#x60;PostedAfter&#x60; parameter. **Default:** Two minutes before the time of the request.
1657
+ */
1658
+ readonly postedBefore?: string;
1659
+ /**
1660
+ * The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1661
+ */
1662
+ readonly nextToken?: string;
1663
+ }
1664
+ /**
1665
+ * Request parameters for listFinancialEventsByGroupId operation in FinancesApi.
1666
+ */
1667
+ interface FinancesApiListFinancialEventsByGroupIdRequest {
1668
+ /**
1669
+ * The identifier of the financial event group to which the events belong.
1670
+ */
1671
+ readonly eventGroupId: string;
1672
+ /**
1673
+ * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1674
+ */
1675
+ readonly maxResultsPerPage?: number;
1676
+ /**
1677
+ * The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
1678
+ */
1679
+ readonly postedAfter?: string;
1680
+ /**
1681
+ * The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. If you include the &#x60;PostedBefore&#x60; parameter in your request, you must also specify the &#x60;PostedAfter&#x60; parameter. **Default:** Two minutes before the time of the request.
1682
+ */
1683
+ readonly postedBefore?: string;
1684
+ /**
1685
+ * The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1686
+ */
1687
+ readonly nextToken?: string;
1688
+ }
1689
+ /**
1690
+ * Request parameters for listFinancialEventsByOrderId operation in FinancesApi.
1691
+ */
1692
+ interface FinancesApiListFinancialEventsByOrderIdRequest {
1693
+ /**
1694
+ * An Amazon-defined order identifier, in 3-7-7 format.
1695
+ */
1696
+ readonly orderId: string;
1697
+ /**
1698
+ * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is &#x60;InvalidInput&#x60;.
1699
+ */
1700
+ readonly maxResultsPerPage?: number;
1701
+ /**
1702
+ * The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1703
+ */
1704
+ readonly nextToken?: string;
1705
+ }
1706
+ /**
1707
+ * FinancesApi - object-oriented interface
1708
+ */
1709
+ declare class FinancesApi extends BaseAPI {
1710
+ /**
1711
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1712
+ * @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
1713
+ * @param {*} [options] Override http request option.
1714
+ * @throws {RequiredError}
1715
+ */
1716
+ listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventGroupsResponse, any, {}>>;
1717
+ /**
1718
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1719
+ * @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
1720
+ * @param {*} [options] Override http request option.
1721
+ * @throws {RequiredError}
1722
+ */
1723
+ listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any, {}>>;
1724
+ /**
1725
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1726
+ * @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
1727
+ * @param {*} [options] Override http request option.
1728
+ * @throws {RequiredError}
1729
+ */
1730
+ listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any, {}>>;
1731
+ /**
1732
+ * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
1733
+ * @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
1734
+ * @param {*} [options] Override http request option.
1735
+ * @throws {RequiredError}
1736
+ */
1737
+ listFinancialEventsByOrderId(requestParameters: FinancesApiListFinancialEventsByOrderIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any, {}>>;
1738
+ }
1739
+ //#endregion
1740
+ //#region src/client.d.ts
1741
+ declare const clientRateLimits: RateLimit[];
1742
+ declare class FinancesApiClient extends FinancesApi {
1743
+ constructor(configuration: ClientConfiguration);
1744
+ }
1745
+ //#endregion
1746
+ export { type AdhocDisbursementEvent, type AdjustmentEvent, type AdjustmentItem, type AffordabilityExpenseEvent, type CapacityReservationBillingEvent, type ChargeComponent, type ChargeInstrument, type ChargeRefundEvent, type ChargeRefundTransaction, type CouponPaymentEvent, type Currency, type DebtRecoveryEvent, type DebtRecoveryItem, type DirectPayment, type EBTRefundReimbursementOnlyEvent, type FBALiquidationEvent, type FailedAdhocDisbursementEvent, type FeeComponent, FinancesApi, FinancesApiAxiosParamCreator, FinancesApiClient, FinancesApiFactory, FinancesApiFp, FinancesApiListFinancialEventGroupsRequest, FinancesApiListFinancialEventsByGroupIdRequest, FinancesApiListFinancialEventsByOrderIdRequest, FinancesApiListFinancialEventsRequest, type FinancialEventGroup, type FinancialEvents, type ImagingServicesFeeEvent, type ListFinancialEventGroupsPayload, type ListFinancialEventGroupsResponse, type ListFinancialEventsPayload, type ListFinancialEventsResponse, type LoanServicingEvent, type ModelError, type NetworkComminglingTransactionEvent, type PayWithAmazonEvent, type ProductAdsPaymentEvent, type Promotion, type RemovalShipmentAdjustmentEvent, type RemovalShipmentEvent, type RemovalShipmentItem, type RemovalShipmentItemAdjustment, type RentalTransactionEvent, type RetrochargeEvent, type SAFETReimbursementEvent, type SAFETReimbursementItem, type SellerDealPaymentEvent, type SellerReviewEnrollmentPaymentEvent, type ServiceFeeEvent, type ShipmentEvent, type ShipmentItem, type SolutionProviderCreditEvent, type TDSReimbursementEvent, type TaxWithheldComponent, type TaxWithholdingEvent, type TaxWithholdingPeriod, type TrialShipmentEvent, type ValueAddedServiceChargeEvent, clientRateLimits };
1747
+ //# sourceMappingURL=index.d.ts.map