@flowio/api-types 0.0.203 → 0.0.204
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.
- package/generated/io.flow.apple.pay.v0.apple-pay.d.ts +4 -4
- package/generated/io.flow.billing.csv.v0.billing-csv.d.ts +381 -0
- package/generated/io.flow.billing.internal.v0.billing-internal.d.ts +1030 -0
- package/generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts +281 -0
- package/generated/io.flow.billing.true.up.v0.billing-true-up.d.ts +46 -30
- package/generated/io.flow.billing.v0.billing.d.ts +23 -15
- package/generated/io.flow.consumer.invoice.v0.consumer-invoice.d.ts +204 -0
- package/generated/io.flow.internal.v0.api-internal.d.ts +104 -24
- package/generated/io.flow.invoice.v0.invoice.d.ts +21 -0
- package/generated/io.flow.v0.api.d.ts +59 -19
- package/index.d.ts +5 -0
- package/package.json +2 -2
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
declare namespace io.flow.billing.reporting.csv.v0.enums {
|
|
2
|
+
type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
|
|
3
|
+
}
|
|
4
|
+
|
|
5
|
+
declare namespace io.flow.billing.reporting.csv.v0.models {
|
|
6
|
+
interface FulfillmentShopperBreakdown {
|
|
7
|
+
readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
8
|
+
readonly 'fees': io.flow.billing.reporting.csv.v0.models.ReportingShopperFees;
|
|
9
|
+
readonly 'product': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
10
|
+
readonly 'subtotal': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
11
|
+
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
12
|
+
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
13
|
+
readonly 'discount': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
14
|
+
readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
interface MarkedAsFinal {
|
|
18
|
+
readonly 'products': boolean;
|
|
19
|
+
readonly 'shipping': boolean;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
interface RefundRecord {
|
|
23
|
+
readonly 'billing_entity': string;
|
|
24
|
+
readonly 'order_id': string;
|
|
25
|
+
readonly 'order_refund_id': string;
|
|
26
|
+
readonly 'refund_created_at_date': string;
|
|
27
|
+
readonly 'reconciliation_date': string;
|
|
28
|
+
readonly 'reconciliation_month': number;
|
|
29
|
+
readonly 'reconciliation_year': number;
|
|
30
|
+
readonly 'order_created_at_date': string;
|
|
31
|
+
readonly 'order_status': string;
|
|
32
|
+
readonly 'b2b_sale': boolean;
|
|
33
|
+
readonly 'a_zero_vat_product_exists': boolean;
|
|
34
|
+
readonly 'payment_merchant_reference'?: string;
|
|
35
|
+
readonly 'merchant_reference'?: string;
|
|
36
|
+
readonly 'merchant_id': string;
|
|
37
|
+
readonly 'merchant_name': string;
|
|
38
|
+
readonly 'destination_country': string;
|
|
39
|
+
readonly 'shopper_country_is_eu': boolean;
|
|
40
|
+
readonly 'order_refund_reason_name': string;
|
|
41
|
+
readonly 'order_refund_status_name': string;
|
|
42
|
+
readonly 'original_ccy': string;
|
|
43
|
+
readonly 'transaction_ccy': string;
|
|
44
|
+
readonly 'total_refund_amount_exc_vat_in_transaction_ccy'?: number;
|
|
45
|
+
readonly 'refund_vat_in_transaction_ccy'?: number;
|
|
46
|
+
readonly 'total_refund_amount_inc_vat_in_transaction_ccy'?: number;
|
|
47
|
+
readonly 'merchant_total_products_refund_amount_exc_vat_in_original_ccy': number;
|
|
48
|
+
readonly 'merchant_shipping_refund_amount_exc_vat_in_transaction_ccy'?: number;
|
|
49
|
+
readonly 'merchant_shipping_refund_amount_exc_vat_in_original_ccy': number;
|
|
50
|
+
readonly 'total_refund_amount_exc_tax_collected_in_shopper_ccy'?: number;
|
|
51
|
+
readonly 'tax_collected_amount_in_shopper_ccy': number;
|
|
52
|
+
readonly 'total_refund_amount_inc_tax_collected_in_shopper_ccy'?: number;
|
|
53
|
+
readonly 'payment_gateway': string;
|
|
54
|
+
readonly 'min_product_customer_vat_rate'?: number;
|
|
55
|
+
readonly 'is_virtual_order': boolean;
|
|
56
|
+
readonly 'is_mixed_virtual_order': boolean;
|
|
57
|
+
readonly 'total_refund_amount_exc_tax_collected_in_usd': number;
|
|
58
|
+
readonly 'tax_collected_amount_in_usd': number;
|
|
59
|
+
readonly 'total_refund_amount_inc_tax_collected_in_usd': number;
|
|
60
|
+
readonly 'total_refund_amount_exc_tax_collected_in_eur': number;
|
|
61
|
+
readonly 'tax_collected_amount_in_eur': number;
|
|
62
|
+
readonly 'total_refund_amount_inc_tax_collected_in_eur': number;
|
|
63
|
+
readonly 'is_wyol_order': boolean;
|
|
64
|
+
readonly 'is_duties_guaranteed': boolean;
|
|
65
|
+
readonly 'invoice_id'?: string;
|
|
66
|
+
readonly 'total_refund_amount_exc_vat_in_entity_ccy': number;
|
|
67
|
+
readonly 'refund_vat_in_entity_ccy': number;
|
|
68
|
+
readonly 'total_refund_amount_inc_vat_in_entity_ccy': number;
|
|
69
|
+
readonly 'merchant_total_products_refund_amount_exc_vat_in_entity_ccy': number;
|
|
70
|
+
readonly 'merchant_shipping_refund_amount_exc_vat_in_entity_ccy': number;
|
|
71
|
+
readonly 'merchant_duties_and_taxes_refund_amount_in_entity_ccy': number;
|
|
72
|
+
readonly 'merchant_service_gesture_amount_exc_vat_in_entity_ccy': number;
|
|
73
|
+
readonly 'customer_prepaid_refund_amount_exc_vat_in_entity_ccy': number;
|
|
74
|
+
readonly 'total_refund_amount_exc_tax_collected_in_entity_ccy': number;
|
|
75
|
+
readonly 'tax_collected_amount_in_entity_ccy': number;
|
|
76
|
+
readonly 'total_refund_amount_inc_tax_collected_in_entity_ccy': number;
|
|
77
|
+
readonly 'conversion_rate_transaction_to_entity_ccy': number;
|
|
78
|
+
readonly 'merchant_order_id': string;
|
|
79
|
+
readonly 'transaction_date': string;
|
|
80
|
+
readonly 'debug_console_order_link': string;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
interface ReportingAddenda {
|
|
84
|
+
readonly 'allocation_order_totals_delta'?: number;
|
|
85
|
+
readonly 'allocation_order_item_discount_delta'?: number;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
interface ReportingAuthorizationReference {
|
|
89
|
+
readonly 'id': string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
interface ReportingBusiness {
|
|
93
|
+
readonly 'vat_registration_number': string;
|
|
94
|
+
readonly 'name'?: string;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
interface ReportingConversionRates {
|
|
98
|
+
readonly 'merchant': number;
|
|
99
|
+
readonly 'entity': number;
|
|
100
|
+
readonly 'usd': number;
|
|
101
|
+
readonly 'eur': number;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
interface ReportingCountry {
|
|
105
|
+
readonly 'code': string;
|
|
106
|
+
readonly 'is_eu': boolean;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
interface ReportingCurrencies {
|
|
110
|
+
readonly 'transaction': string;
|
|
111
|
+
readonly 'merchant': string;
|
|
112
|
+
readonly 'entity': string;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
interface ReportingDebug {
|
|
116
|
+
readonly 'console_order_link': string;
|
|
117
|
+
readonly 'addenda'?: io.flow.billing.reporting.csv.v0.models.ReportingAddenda;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
interface ReportingDestination {
|
|
121
|
+
readonly 'country': io.flow.billing.reporting.csv.v0.models.ReportingCountry;
|
|
122
|
+
readonly 'province'?: io.flow.billing.reporting.csv.v0.models.ReportingProvince;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
interface ReportingEntity {
|
|
126
|
+
readonly 'id': string;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
interface ReportingFulfillment {
|
|
130
|
+
readonly 'id': string;
|
|
131
|
+
readonly 'sequence_number': number;
|
|
132
|
+
readonly 'fulfilled_at': string;
|
|
133
|
+
readonly 'completes_order': boolean;
|
|
134
|
+
readonly 'payment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPayment;
|
|
135
|
+
readonly 'value': io.flow.billing.reporting.csv.v0.models.FulfillmentShopperBreakdown;
|
|
136
|
+
readonly 'dispatch_country'?: io.flow.billing.reporting.csv.v0.models.ReportingCountry;
|
|
137
|
+
readonly 'destination': io.flow.billing.reporting.csv.v0.models.ReportingDestination;
|
|
138
|
+
readonly 'carrier'?: string;
|
|
139
|
+
readonly 'is': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentIs;
|
|
140
|
+
readonly 'has': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentHas;
|
|
141
|
+
readonly 'fx': io.flow.billing.reporting.csv.v0.models.ReportingFx;
|
|
142
|
+
readonly 'business'?: io.flow.billing.reporting.csv.v0.models.ReportingBusiness;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
interface ReportingFulfillmentHas {
|
|
146
|
+
readonly 'zero_vat_product': boolean;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
interface ReportingFulfillmentIs {
|
|
150
|
+
readonly 'replacement': boolean;
|
|
151
|
+
readonly 'virtual': io.flow.billing.reporting.csv.v0.enums.ReportingFulfillmentIsVirtual;
|
|
152
|
+
readonly 'duties_guaranteed': boolean;
|
|
153
|
+
readonly 'wyol': boolean;
|
|
154
|
+
readonly 'b2b': boolean;
|
|
155
|
+
readonly 'domestic': boolean;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
interface ReportingFulfillmentPayment {
|
|
159
|
+
readonly 'metadata'?: io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPaymentMetadata;
|
|
160
|
+
readonly 'psp': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
161
|
+
readonly 'credit': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
162
|
+
readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
interface ReportingFulfillmentPaymentMetadata {
|
|
166
|
+
readonly 'gateway': io.flow.payment.internal.v0.enums.Processor;
|
|
167
|
+
readonly 'method': string;
|
|
168
|
+
readonly 'psp_reference'?: string;
|
|
169
|
+
readonly 'authorization'?: io.flow.billing.reporting.csv.v0.models.ReportingAuthorizationReference;
|
|
170
|
+
readonly 'settlement_date': string;
|
|
171
|
+
readonly 'additional_authorizations'?: io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPaymentMetadataAdditionalAuthorizations;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
interface ReportingFulfillmentPaymentMetadataAdditionalAuthorizations {
|
|
175
|
+
readonly 'ids': string;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
interface ReportingFx {
|
|
179
|
+
readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
180
|
+
readonly 'fees': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
181
|
+
readonly 'product': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
182
|
+
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
183
|
+
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
184
|
+
readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
interface ReportingMerchantFees {
|
|
188
|
+
readonly 'duty_guarantee': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
189
|
+
readonly 'mor': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
190
|
+
readonly 'fraud': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
191
|
+
readonly 'fx': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
192
|
+
readonly 'processing': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
193
|
+
readonly 'rate_lock': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
194
|
+
readonly 'transfer': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
interface ReportingMerchantSubsidies {
|
|
198
|
+
readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
199
|
+
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
200
|
+
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
201
|
+
readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
interface ReportingMonetaryValue {
|
|
205
|
+
readonly 'transaction': number;
|
|
206
|
+
readonly 'merchant': number;
|
|
207
|
+
readonly 'entity': number;
|
|
208
|
+
readonly 'usd': number;
|
|
209
|
+
readonly 'eur': number;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
interface ReportingOrderSummary {
|
|
213
|
+
readonly 'id': string;
|
|
214
|
+
readonly 'number': string;
|
|
215
|
+
readonly 'submitted_at': string;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
interface ReportingOrganizationSummary {
|
|
219
|
+
readonly 'id': string;
|
|
220
|
+
readonly 'name': string;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
interface ReportingProvince {
|
|
224
|
+
readonly 'code'?: string;
|
|
225
|
+
readonly 'name': string;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
interface ReportingReconciliation {
|
|
229
|
+
readonly 'date': string;
|
|
230
|
+
readonly 'month': number;
|
|
231
|
+
readonly 'year': number;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
interface ReportingShopperFees {
|
|
235
|
+
readonly 'fuel': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
236
|
+
readonly 'remote_area': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
237
|
+
readonly 'oversize': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
238
|
+
readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
239
|
+
readonly 'emergency': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
240
|
+
readonly 'peak': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
interface ReportingUsd {
|
|
244
|
+
readonly 'usd': number;
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
interface ReportingVatRemittance {
|
|
248
|
+
readonly 'currency': string;
|
|
249
|
+
readonly 'rate': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittanceRate;
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
interface ReportingVatRemittanceRate {
|
|
253
|
+
readonly 'entity': number;
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
interface ReportingVendor {
|
|
257
|
+
readonly 'id': string;
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
interface SalesRecord {
|
|
261
|
+
readonly 'id': string;
|
|
262
|
+
readonly 'parent'?: io.flow.billing.reporting.csv.v0.models.SalesRecordReference;
|
|
263
|
+
readonly 'merchant': io.flow.billing.reporting.csv.v0.models.ReportingOrganizationSummary;
|
|
264
|
+
readonly 'order': io.flow.billing.reporting.csv.v0.models.ReportingOrderSummary;
|
|
265
|
+
readonly 'entity': io.flow.billing.reporting.csv.v0.models.ReportingEntity;
|
|
266
|
+
readonly 'vendor': io.flow.billing.reporting.csv.v0.models.ReportingVendor;
|
|
267
|
+
readonly 'currencies': io.flow.billing.reporting.csv.v0.models.ReportingCurrencies;
|
|
268
|
+
readonly 'conversion_rate': io.flow.billing.reporting.csv.v0.models.ReportingConversionRates;
|
|
269
|
+
readonly 'fulfillment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillment;
|
|
270
|
+
readonly 'reconciliation': io.flow.billing.reporting.csv.v0.models.ReportingReconciliation;
|
|
271
|
+
readonly 'marked_as_final': io.flow.billing.reporting.csv.v0.models.MarkedAsFinal;
|
|
272
|
+
readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
|
|
273
|
+
readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
|
|
274
|
+
readonly 'vat_remittance': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittance;
|
|
275
|
+
readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
interface SalesRecordReference {
|
|
279
|
+
readonly 'id': string;
|
|
280
|
+
}
|
|
281
|
+
}
|
|
@@ -3,64 +3,78 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.enums {
|
|
|
3
3
|
}
|
|
4
4
|
|
|
5
5
|
declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
|
|
6
|
-
interface
|
|
7
|
-
readonly 'amount': number;
|
|
8
|
-
readonly 'weight': number;
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
interface LabelDestination {
|
|
12
|
-
readonly 'country': string;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
interface LabelInvoiceRequest {
|
|
16
|
-
readonly 'id': string;
|
|
17
|
-
readonly 'label': io.flow.billing.RESERVED_WORD_true.up.v0.models.TrueUpLabelSummary;
|
|
18
|
-
readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelUnits;
|
|
19
|
-
readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
|
|
20
|
-
readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurcharge[];
|
|
21
|
-
readonly 'total': number;
|
|
22
|
-
readonly 'destination': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelDestination;
|
|
23
|
-
readonly 'metadata': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelMetadata;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
interface LabelInvoiceResponseFile {
|
|
6
|
+
interface CarrierChargeFile {
|
|
27
7
|
readonly 'id': string;
|
|
28
8
|
readonly 'url': string;
|
|
29
9
|
readonly 'created_at': string;
|
|
30
|
-
readonly 'result'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.
|
|
10
|
+
readonly 'result'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeFileResult;
|
|
31
11
|
}
|
|
32
12
|
|
|
33
|
-
interface
|
|
13
|
+
interface CarrierChargeFileForm {
|
|
34
14
|
readonly 'url': string;
|
|
35
15
|
}
|
|
36
16
|
|
|
37
|
-
interface
|
|
17
|
+
interface CarrierChargeFileResult {
|
|
38
18
|
readonly 'processed_at': string;
|
|
39
19
|
readonly 'number_lines_successful': number;
|
|
40
20
|
readonly 'number_lines_with_errors': number;
|
|
41
21
|
readonly 'errors_url'?: string;
|
|
42
22
|
}
|
|
43
23
|
|
|
44
|
-
interface
|
|
24
|
+
interface CarrierChargeFormLabel {
|
|
25
|
+
readonly 'discriminator': 'label';
|
|
45
26
|
readonly 'id': string;
|
|
46
27
|
readonly 'label_invoice_request_id': string;
|
|
47
|
-
readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.
|
|
28
|
+
readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeUnits;
|
|
48
29
|
readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
|
|
49
30
|
readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeForm;
|
|
50
31
|
readonly 'total': number;
|
|
32
|
+
readonly 'attributes'?: Record<string, string>;
|
|
51
33
|
}
|
|
52
34
|
|
|
53
|
-
interface
|
|
54
|
-
readonly '
|
|
55
|
-
readonly '
|
|
35
|
+
interface CarrierChargeFormReturnToOrigin {
|
|
36
|
+
readonly 'discriminator': 'return_to_origin';
|
|
37
|
+
readonly 'id': string;
|
|
38
|
+
readonly 'carrier_id': string;
|
|
39
|
+
readonly 'carrier_tracking_number': string;
|
|
40
|
+
readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeUnits;
|
|
41
|
+
readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
|
|
42
|
+
readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeForm;
|
|
43
|
+
readonly 'total': number;
|
|
44
|
+
readonly 'attributes'?: Record<string, string>;
|
|
56
45
|
}
|
|
57
46
|
|
|
58
|
-
interface
|
|
47
|
+
interface CarrierChargeUnits {
|
|
59
48
|
readonly 'currency': string;
|
|
60
49
|
readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
|
|
61
50
|
readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
|
|
62
51
|
}
|
|
63
52
|
|
|
53
|
+
interface LabelBase {
|
|
54
|
+
readonly 'amount': number;
|
|
55
|
+
readonly 'weight': number;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
interface LabelDestination {
|
|
59
|
+
readonly 'country': string;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
interface LabelInvoiceRequest {
|
|
63
|
+
readonly 'id': string;
|
|
64
|
+
readonly 'label': io.flow.billing.RESERVED_WORD_true.up.v0.models.TrueUpLabelSummary;
|
|
65
|
+
readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelUnits;
|
|
66
|
+
readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
|
|
67
|
+
readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurcharge[];
|
|
68
|
+
readonly 'total': number;
|
|
69
|
+
readonly 'destination': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelDestination;
|
|
70
|
+
readonly 'metadata': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelMetadata;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
interface LabelMetadata {
|
|
74
|
+
readonly 'ratecard': io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataRatecard;
|
|
75
|
+
readonly 'weights': io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataWeights;
|
|
76
|
+
}
|
|
77
|
+
|
|
64
78
|
interface LabelSurcharge {
|
|
65
79
|
readonly 'amount': number;
|
|
66
80
|
readonly 'type': io.flow.billing.RESERVED_WORD_true.up.v0.enums.TrueUpSurchargeType;
|
|
@@ -128,6 +142,7 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
|
|
|
128
142
|
readonly 'carrier_service_id': string;
|
|
129
143
|
readonly 'carrier_tracking_number': string;
|
|
130
144
|
readonly 'flow_tracking_number': string;
|
|
145
|
+
readonly 'source': io.flow.label.v0.enums.CostEstimateSource;
|
|
131
146
|
readonly 'created_at': string;
|
|
132
147
|
}
|
|
133
148
|
|
|
@@ -144,5 +159,6 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
|
|
|
144
159
|
}
|
|
145
160
|
|
|
146
161
|
declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.unions {
|
|
162
|
+
type CarrierChargeForm = (io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeFormLabel | io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeFormReturnToOrigin);
|
|
147
163
|
type LabelSurchargeDetail = (io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeDetailFlat | io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeDetailPercentage | io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeDetailPerWeightUnit);
|
|
148
164
|
}
|
|
@@ -2,8 +2,8 @@ declare namespace io.flow.billing.v0.enums {
|
|
|
2
2
|
type FeeDeductionType = 'duty_guarantee' | 'mor' | 'fraud' | 'fx' | 'processing' | 'rate_lock' | 'transfer';
|
|
3
3
|
type PayoutAttachmentType = 'transactions';
|
|
4
4
|
type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
|
|
5
|
+
type PendingPayoutTransactionReasonCode = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'external_fulfillment_missing_tracking_info' | 'waiting_for_positive_account_balance';
|
|
5
6
|
type StatementAttachmentType = 'csv';
|
|
6
|
-
type TransactionPayoutPendingReason = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'external_fulfillment_missing_tracking_info' | 'waiting_for_positive_account_balance';
|
|
7
7
|
type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'trueup' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
|
|
8
8
|
type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
|
|
9
9
|
type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
|
|
@@ -86,6 +86,12 @@ declare namespace io.flow.billing.v0.models {
|
|
|
86
86
|
readonly 'updated_at': string;
|
|
87
87
|
}
|
|
88
88
|
|
|
89
|
+
interface ChannelPendingPayoutTransaction {
|
|
90
|
+
readonly 'id': string;
|
|
91
|
+
readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
|
|
92
|
+
readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
|
|
93
|
+
}
|
|
94
|
+
|
|
89
95
|
interface ChannelStatement {
|
|
90
96
|
readonly 'id': string;
|
|
91
97
|
readonly 'account': io.flow.billing.v0.models.AccountReference;
|
|
@@ -114,12 +120,6 @@ declare namespace io.flow.billing.v0.models {
|
|
|
114
120
|
readonly 'updated_at': string;
|
|
115
121
|
}
|
|
116
122
|
|
|
117
|
-
interface ChannelTransactionPayout {
|
|
118
|
-
readonly 'transaction': io.flow.billing.v0.models.TransactionReference;
|
|
119
|
-
readonly 'waiting_for'?: io.flow.billing.v0.enums.TransactionPayoutPendingReason;
|
|
120
|
-
readonly 'payout'?: io.flow.billing.v0.models.PayoutReference;
|
|
121
|
-
}
|
|
122
|
-
|
|
123
123
|
interface DefaultBankAccountForm {
|
|
124
124
|
readonly 'bank_account_id': string;
|
|
125
125
|
}
|
|
@@ -152,10 +152,10 @@ declare namespace io.flow.billing.v0.models {
|
|
|
152
152
|
readonly 'updated_at': string;
|
|
153
153
|
}
|
|
154
154
|
|
|
155
|
-
interface
|
|
156
|
-
readonly '
|
|
157
|
-
readonly '
|
|
158
|
-
readonly '
|
|
155
|
+
interface OrganizationPendingPayoutTransaction {
|
|
156
|
+
readonly 'id': string;
|
|
157
|
+
readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
|
|
158
|
+
readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
|
|
159
159
|
}
|
|
160
160
|
|
|
161
161
|
interface ParentTransactionSummary {
|
|
@@ -206,10 +206,13 @@ declare namespace io.flow.billing.v0.models {
|
|
|
206
206
|
readonly 'updated_at': string;
|
|
207
207
|
}
|
|
208
208
|
|
|
209
|
-
interface
|
|
210
|
-
readonly '
|
|
211
|
-
readonly '
|
|
212
|
-
|
|
209
|
+
interface PendingPayoutTransactionReason {
|
|
210
|
+
readonly 'code': io.flow.billing.v0.enums.PendingPayoutTransactionReasonCode;
|
|
211
|
+
readonly 'created_at': string;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
interface PendingPayoutTransactionTimeout {
|
|
215
|
+
readonly 'created_at': string;
|
|
213
216
|
}
|
|
214
217
|
|
|
215
218
|
interface SettlementNoPayout {
|
|
@@ -275,6 +278,7 @@ declare namespace io.flow.billing.v0.models {
|
|
|
275
278
|
|
|
276
279
|
interface TransactionMetadataTrueup {
|
|
277
280
|
readonly 'discriminator': 'trueup';
|
|
281
|
+
readonly 'original': io.flow.billing.v0.models.TransactionMetadataTrueupOriginalTransaction;
|
|
278
282
|
readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupData;
|
|
279
283
|
readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupData;
|
|
280
284
|
}
|
|
@@ -287,6 +291,10 @@ declare namespace io.flow.billing.v0.models {
|
|
|
287
291
|
readonly 'total': number;
|
|
288
292
|
}
|
|
289
293
|
|
|
294
|
+
interface TransactionMetadataTrueupOriginalTransaction {
|
|
295
|
+
readonly 'id': string;
|
|
296
|
+
}
|
|
297
|
+
|
|
290
298
|
interface TransactionReference {
|
|
291
299
|
readonly 'id': string;
|
|
292
300
|
}
|