@flowio/api-types 0.0.203 → 0.0.205
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 +418 -0
- package/generated/io.flow.billing.internal.v0.billing-internal.d.ts +1037 -0
- package/generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts +294 -0
- package/generated/io.flow.billing.v0.billing.d.ts +44 -18
- package/generated/io.flow.consumer.invoice.v0.consumer-invoice.d.ts +204 -0
- package/generated/io.flow.external.paypal.v1.paypal.d.ts +38 -9
- package/generated/io.flow.internal.v0.api-internal.d.ts +298 -140
- package/generated/io.flow.invoice.v0.invoice.d.ts +21 -0
- package/generated/io.flow.label.v0.label.d.ts +4 -3
- package/generated/io.flow.payment.v0.payment.d.ts +13 -0
- package/generated/io.flow.ratecard.v0.ratecard.d.ts +14 -0
- package/generated/io.flow.shopify.markets.v0.shopify-markets.d.ts +1 -1
- package/generated/io.flow.stripe.v0.stripe.d.ts +1 -0
- package/generated/io.flow.trueup.v0.trueup.d.ts +52 -0
- package/generated/io.flow.v0.api.d.ts +166 -23
- package/index.d.ts +6 -1
- package/package.json +2 -2
- package/generated/io.flow.billing.true.up.v0.billing-true-up.d.ts +0 -148
|
@@ -0,0 +1,294 @@
|
|
|
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 ReportingAuthorizationReference {
|
|
84
|
+
readonly 'id': string;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
interface ReportingBusiness {
|
|
88
|
+
readonly 'vat_registration_number': string;
|
|
89
|
+
readonly 'name'?: string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
interface ReportingConversionRates {
|
|
93
|
+
readonly 'merchant': number;
|
|
94
|
+
readonly 'entity': number;
|
|
95
|
+
readonly 'usd': number;
|
|
96
|
+
readonly 'eur': number;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
interface ReportingCountry {
|
|
100
|
+
readonly 'code': string;
|
|
101
|
+
readonly 'is_eu': boolean;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
interface ReportingCurrencies {
|
|
105
|
+
readonly 'transaction': string;
|
|
106
|
+
readonly 'merchant': string;
|
|
107
|
+
readonly 'entity': string;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
interface ReportingDebug {
|
|
111
|
+
readonly 'console_order_link': string;
|
|
112
|
+
readonly 'allocation_order_totals_delta'?: number;
|
|
113
|
+
readonly 'allocation_order_item_discount_delta'?: number;
|
|
114
|
+
readonly 'missing_item_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
|
|
115
|
+
readonly 'missing_shipping_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
interface ReportingDebugMissingSubsidies {
|
|
119
|
+
readonly 'price'?: boolean;
|
|
120
|
+
readonly 'tax'?: boolean;
|
|
121
|
+
readonly 'duty'?: boolean;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
interface ReportingDestination {
|
|
125
|
+
readonly 'country': io.flow.billing.reporting.csv.v0.models.ReportingCountry;
|
|
126
|
+
readonly 'province'?: io.flow.billing.reporting.csv.v0.models.ReportingProvince;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
interface ReportingEntity {
|
|
130
|
+
readonly 'id': string;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
interface ReportingFulfillment {
|
|
134
|
+
readonly 'id': string;
|
|
135
|
+
readonly 'sequence_number': number;
|
|
136
|
+
readonly 'fulfilled_at': string;
|
|
137
|
+
readonly 'completes_order': boolean;
|
|
138
|
+
readonly 'payment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPayment;
|
|
139
|
+
readonly 'value': io.flow.billing.reporting.csv.v0.models.FulfillmentShopperBreakdown;
|
|
140
|
+
readonly 'dispatch_country'?: io.flow.billing.reporting.csv.v0.models.ReportingCountry;
|
|
141
|
+
readonly 'destination': io.flow.billing.reporting.csv.v0.models.ReportingDestination;
|
|
142
|
+
readonly 'carrier'?: string;
|
|
143
|
+
readonly 'is': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentIs;
|
|
144
|
+
readonly 'has': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentHas;
|
|
145
|
+
readonly 'fx': io.flow.billing.reporting.csv.v0.models.ReportingFx;
|
|
146
|
+
readonly 'business'?: io.flow.billing.reporting.csv.v0.models.ReportingBusiness;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
interface ReportingFulfillmentHas {
|
|
150
|
+
readonly 'zero_vat_product': boolean;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
interface ReportingFulfillmentIs {
|
|
154
|
+
readonly 'replacement': boolean;
|
|
155
|
+
readonly 'virtual': io.flow.billing.reporting.csv.v0.enums.ReportingFulfillmentIsVirtual;
|
|
156
|
+
readonly 'duties_guaranteed': boolean;
|
|
157
|
+
readonly 'wyol': boolean;
|
|
158
|
+
readonly 'b2b': boolean;
|
|
159
|
+
readonly 'domestic': boolean;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
interface ReportingFulfillmentPayment {
|
|
163
|
+
readonly 'metadata'?: io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPaymentMetadata;
|
|
164
|
+
readonly 'psp': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
165
|
+
readonly 'credit': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
166
|
+
readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
interface ReportingFulfillmentPaymentMetadata {
|
|
170
|
+
readonly 'gateway': io.flow.payment.internal.v0.enums.Processor;
|
|
171
|
+
readonly 'method': string;
|
|
172
|
+
readonly 'psp_reference'?: string;
|
|
173
|
+
readonly 'authorization'?: io.flow.billing.reporting.csv.v0.models.ReportingAuthorizationReference;
|
|
174
|
+
readonly 'settlement_date': string;
|
|
175
|
+
readonly 'additional_authorizations'?: io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPaymentMetadataAdditionalAuthorizations;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
interface ReportingFulfillmentPaymentMetadataAdditionalAuthorizations {
|
|
179
|
+
readonly 'ids': string;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
interface ReportingFx {
|
|
183
|
+
readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
184
|
+
readonly 'fees': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
185
|
+
readonly 'product': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
186
|
+
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
187
|
+
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
188
|
+
readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
interface ReportingMerchantFees {
|
|
192
|
+
readonly 'duty_guarantee': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
193
|
+
readonly 'mor': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
194
|
+
readonly 'fraud': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
195
|
+
readonly 'fx': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
196
|
+
readonly 'processing': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
197
|
+
readonly 'rate_lock': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
198
|
+
readonly 'transfer': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
interface ReportingMerchantSubsidies {
|
|
202
|
+
readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
203
|
+
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
204
|
+
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
205
|
+
readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
interface ReportingMerchantTransactions {
|
|
209
|
+
readonly 'adjustment': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
210
|
+
readonly 'reversal': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
211
|
+
readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
212
|
+
readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
213
|
+
readonly 'freight': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
interface ReportingMonetaryValue {
|
|
217
|
+
readonly 'transaction': number;
|
|
218
|
+
readonly 'merchant': number;
|
|
219
|
+
readonly 'entity': number;
|
|
220
|
+
readonly 'usd': number;
|
|
221
|
+
readonly 'eur': number;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
interface ReportingOrderSummary {
|
|
225
|
+
readonly 'id': string;
|
|
226
|
+
readonly 'number': string;
|
|
227
|
+
readonly 'submitted_at': string;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
interface ReportingOrganizationSummary {
|
|
231
|
+
readonly 'id': string;
|
|
232
|
+
readonly 'name': string;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
interface ReportingProvince {
|
|
236
|
+
readonly 'code'?: string;
|
|
237
|
+
readonly 'name': string;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
interface ReportingReconciliation {
|
|
241
|
+
readonly 'date': string;
|
|
242
|
+
readonly 'month': number;
|
|
243
|
+
readonly 'year': number;
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
interface ReportingShopperFees {
|
|
247
|
+
readonly 'fuel': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
248
|
+
readonly 'remote_area': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
249
|
+
readonly 'oversize': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
250
|
+
readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
251
|
+
readonly 'emergency': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
252
|
+
readonly 'peak': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
interface ReportingUsd {
|
|
256
|
+
readonly 'usd': number;
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
interface ReportingVatRemittance {
|
|
260
|
+
readonly 'currency': string;
|
|
261
|
+
readonly 'rate': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittanceRate;
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
interface ReportingVatRemittanceRate {
|
|
265
|
+
readonly 'entity': number;
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
interface ReportingVendor {
|
|
269
|
+
readonly 'id': string;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
interface SalesRecord {
|
|
273
|
+
readonly 'id': string;
|
|
274
|
+
readonly 'parent'?: io.flow.billing.reporting.csv.v0.models.SalesRecordReference;
|
|
275
|
+
readonly 'merchant': io.flow.billing.reporting.csv.v0.models.ReportingOrganizationSummary;
|
|
276
|
+
readonly 'order': io.flow.billing.reporting.csv.v0.models.ReportingOrderSummary;
|
|
277
|
+
readonly 'entity': io.flow.billing.reporting.csv.v0.models.ReportingEntity;
|
|
278
|
+
readonly 'vendor': io.flow.billing.reporting.csv.v0.models.ReportingVendor;
|
|
279
|
+
readonly 'currencies': io.flow.billing.reporting.csv.v0.models.ReportingCurrencies;
|
|
280
|
+
readonly 'conversion_rate': io.flow.billing.reporting.csv.v0.models.ReportingConversionRates;
|
|
281
|
+
readonly 'fulfillment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillment;
|
|
282
|
+
readonly 'reconciliation': io.flow.billing.reporting.csv.v0.models.ReportingReconciliation;
|
|
283
|
+
readonly 'marked_as_final': io.flow.billing.reporting.csv.v0.models.MarkedAsFinal;
|
|
284
|
+
readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
|
|
285
|
+
readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
|
|
286
|
+
readonly 'merchant_transactions': io.flow.billing.reporting.csv.v0.models.ReportingMerchantTransactions;
|
|
287
|
+
readonly 'vat_remittance': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittance;
|
|
288
|
+
readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
interface SalesRecordReference {
|
|
292
|
+
readonly 'id': string;
|
|
293
|
+
}
|
|
294
|
+
}
|
|
@@ -2,11 +2,10 @@ 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' | 'waiting_for_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
|
-
type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
|
|
10
9
|
type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
|
|
11
10
|
}
|
|
12
11
|
|
|
@@ -86,6 +85,15 @@ declare namespace io.flow.billing.v0.models {
|
|
|
86
85
|
readonly 'updated_at': string;
|
|
87
86
|
}
|
|
88
87
|
|
|
88
|
+
interface ChannelPendingPayoutTransaction {
|
|
89
|
+
readonly 'id': string;
|
|
90
|
+
readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
|
|
91
|
+
readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
|
|
92
|
+
readonly 'created_at': string;
|
|
93
|
+
readonly 'updated_at': string;
|
|
94
|
+
readonly 'deleted_at'?: string;
|
|
95
|
+
}
|
|
96
|
+
|
|
89
97
|
interface ChannelStatement {
|
|
90
98
|
readonly 'id': string;
|
|
91
99
|
readonly 'account': io.flow.billing.v0.models.AccountReference;
|
|
@@ -114,12 +122,6 @@ declare namespace io.flow.billing.v0.models {
|
|
|
114
122
|
readonly 'updated_at': string;
|
|
115
123
|
}
|
|
116
124
|
|
|
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
125
|
interface DefaultBankAccountForm {
|
|
124
126
|
readonly 'bank_account_id': string;
|
|
125
127
|
}
|
|
@@ -152,10 +154,13 @@ declare namespace io.flow.billing.v0.models {
|
|
|
152
154
|
readonly 'updated_at': string;
|
|
153
155
|
}
|
|
154
156
|
|
|
155
|
-
interface
|
|
156
|
-
readonly '
|
|
157
|
-
readonly '
|
|
158
|
-
readonly '
|
|
157
|
+
interface OrganizationPendingPayoutTransaction {
|
|
158
|
+
readonly 'id': string;
|
|
159
|
+
readonly 'reason': io.flow.billing.v0.models.PendingPayoutTransactionReason;
|
|
160
|
+
readonly 'timeout'?: io.flow.billing.v0.models.PendingPayoutTransactionTimeout;
|
|
161
|
+
readonly 'created_at': string;
|
|
162
|
+
readonly 'updated_at': string;
|
|
163
|
+
readonly 'deleted_at'?: string;
|
|
159
164
|
}
|
|
160
165
|
|
|
161
166
|
interface ParentTransactionSummary {
|
|
@@ -206,10 +211,13 @@ declare namespace io.flow.billing.v0.models {
|
|
|
206
211
|
readonly 'updated_at': string;
|
|
207
212
|
}
|
|
208
213
|
|
|
209
|
-
interface
|
|
210
|
-
readonly '
|
|
211
|
-
readonly '
|
|
212
|
-
|
|
214
|
+
interface PendingPayoutTransactionReason {
|
|
215
|
+
readonly 'code': io.flow.billing.v0.enums.PendingPayoutTransactionReasonCode;
|
|
216
|
+
readonly 'created_at': string;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
interface PendingPayoutTransactionTimeout {
|
|
220
|
+
readonly 'created_at': string;
|
|
213
221
|
}
|
|
214
222
|
|
|
215
223
|
interface SettlementNoPayout {
|
|
@@ -268,13 +276,29 @@ declare namespace io.flow.billing.v0.models {
|
|
|
268
276
|
readonly 'country': string;
|
|
269
277
|
}
|
|
270
278
|
|
|
279
|
+
interface TransactionMetadataManual {
|
|
280
|
+
readonly 'discriminator': 'manual';
|
|
281
|
+
readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
interface TransactionMetadataOriginalTransaction {
|
|
285
|
+
readonly 'id': string;
|
|
286
|
+
}
|
|
287
|
+
|
|
271
288
|
interface TransactionMetadataShippingLabel {
|
|
272
289
|
readonly 'discriminator': 'shipping_label';
|
|
273
290
|
readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
|
|
291
|
+
readonly 'carrier': io.flow.billing.v0.models.TransactionMetadataShippingLabelCarrier;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
interface TransactionMetadataShippingLabelCarrier {
|
|
295
|
+
readonly 'id': string;
|
|
296
|
+
readonly 'tracking_number': string;
|
|
274
297
|
}
|
|
275
298
|
|
|
276
299
|
interface TransactionMetadataTrueup {
|
|
277
300
|
readonly 'discriminator': 'trueup';
|
|
301
|
+
readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
|
|
278
302
|
readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupData;
|
|
279
303
|
readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupData;
|
|
280
304
|
}
|
|
@@ -285,6 +309,8 @@ declare namespace io.flow.billing.v0.models {
|
|
|
285
309
|
readonly 'base': io.flow.billing.v0.models.TrueupLabelBase;
|
|
286
310
|
readonly 'surcharges': io.flow.billing.v0.models.TrueupLabelSurcharge[];
|
|
287
311
|
readonly 'total': number;
|
|
312
|
+
readonly 'dead'?: io.flow.trueup.v0.models.DeadWeight;
|
|
313
|
+
readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
|
|
288
314
|
}
|
|
289
315
|
|
|
290
316
|
interface TransactionReference {
|
|
@@ -298,7 +324,7 @@ declare namespace io.flow.billing.v0.models {
|
|
|
298
324
|
|
|
299
325
|
interface TrueupLabelSurcharge {
|
|
300
326
|
readonly 'amount': number;
|
|
301
|
-
readonly 'type': io.flow.
|
|
327
|
+
readonly 'type': io.flow.trueup.v0.enums.TrueupSurchargeType;
|
|
302
328
|
readonly 'percentage'?: number;
|
|
303
329
|
readonly 'per_weight_unit'?: number;
|
|
304
330
|
}
|
|
@@ -319,5 +345,5 @@ declare namespace io.flow.billing.v0.unions {
|
|
|
319
345
|
type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
|
|
320
346
|
type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
|
|
321
347
|
type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
|
|
322
|
-
type TransactionMetadata = (io.flow.billing.v0.models.TransactionMetadataShippingLabel | io.flow.billing.v0.models.TransactionMetadataChannel | io.flow.billing.v0.models.TransactionMetadataTrueup);
|
|
348
|
+
type TransactionMetadata = (io.flow.billing.v0.models.TransactionMetadataShippingLabel | io.flow.billing.v0.models.TransactionMetadataChannel | io.flow.billing.v0.models.TransactionMetadataTrueup | io.flow.billing.v0.models.TransactionMetadataManual);
|
|
323
349
|
}
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
declare namespace io.flow.consumer.invoice.v0.enums {
|
|
2
|
+
type B2BInvoiceType = 'self_bill_invoice' | 'invoice';
|
|
3
|
+
type ConsumerInvoiceCustomerType = 'business_eu_verified' | 'business_non_verified' | 'individual';
|
|
4
|
+
type ConsumerInvoiceDocumentType = 'pdf';
|
|
5
|
+
type ConsumerInvoiceStatus = 'pending' | 'available' | 'invalid';
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
declare namespace io.flow.consumer.invoice.v0.models {
|
|
9
|
+
interface B2BCreditMemo {
|
|
10
|
+
readonly 'id': string;
|
|
11
|
+
readonly 'number': string;
|
|
12
|
+
readonly 'buyer': io.flow.common.v0.models.MerchantOfRecordEntity;
|
|
13
|
+
readonly 'seller': io.flow.common.v0.models.MerchantOfRecordEntity;
|
|
14
|
+
readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
|
|
15
|
+
readonly 'date': string;
|
|
16
|
+
readonly 'key': string;
|
|
17
|
+
readonly 'invoice': io.flow.consumer.invoice.v0.models.B2BInvoiceReference;
|
|
18
|
+
readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
|
|
19
|
+
readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
|
|
20
|
+
readonly 'attributes': Record<string, string>;
|
|
21
|
+
readonly 'b2b_invoice_type': io.flow.consumer.invoice.v0.enums.B2BInvoiceType;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
interface B2BInvoice {
|
|
25
|
+
readonly 'id': string;
|
|
26
|
+
readonly 'number': string;
|
|
27
|
+
readonly 'buyer': io.flow.common.v0.models.MerchantOfRecordEntity;
|
|
28
|
+
readonly 'seller': io.flow.common.v0.models.MerchantOfRecordEntity;
|
|
29
|
+
readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
|
|
30
|
+
readonly 'date': string;
|
|
31
|
+
readonly 'key': string;
|
|
32
|
+
readonly 'order': io.flow.consumer.invoice.v0.models.ConsumerInvoiceOrderSummary;
|
|
33
|
+
readonly 'economic_title_location': io.flow.merchant.of.record.v0.enums.EconomicTitleLocation;
|
|
34
|
+
readonly 'center'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceCenterReference;
|
|
35
|
+
readonly 'destination'?: io.flow.experience.v0.models.OrderAddress;
|
|
36
|
+
readonly 'tax': io.flow.common.v0.models.Money;
|
|
37
|
+
readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
|
|
38
|
+
readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
|
|
39
|
+
readonly 'attributes': Record<string, string>;
|
|
40
|
+
readonly 'estimated_delivery_date'?: string;
|
|
41
|
+
readonly 'b2b_invoice_type': io.flow.consumer.invoice.v0.enums.B2BInvoiceType;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
interface B2BInvoiceReference {
|
|
45
|
+
readonly 'id': string;
|
|
46
|
+
readonly 'key': string;
|
|
47
|
+
readonly 'number': string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
interface ConsumerInvoice {
|
|
51
|
+
readonly 'id': string;
|
|
52
|
+
readonly 'number': string;
|
|
53
|
+
readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
|
|
54
|
+
readonly 'date': string;
|
|
55
|
+
readonly 'key': string;
|
|
56
|
+
readonly 'order': io.flow.consumer.invoice.v0.models.ConsumerInvoiceOrderSummary;
|
|
57
|
+
readonly 'entity': io.flow.common.v0.models.MerchantOfRecordEntity;
|
|
58
|
+
readonly 'payments': io.flow.consumer.invoice.v0.models.ConsumerInvoicePayment[];
|
|
59
|
+
readonly 'center'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceCenterReference;
|
|
60
|
+
readonly 'destination': io.flow.experience.v0.models.OrderAddress;
|
|
61
|
+
readonly 'billing_address'?: io.flow.common.v0.models.BillingAddress;
|
|
62
|
+
readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
|
|
63
|
+
readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
|
|
64
|
+
readonly 'attributes': Record<string, string>;
|
|
65
|
+
readonly 'tax_registration'?: io.flow.harmonization.v0.models.TaxRegistration;
|
|
66
|
+
readonly 'customer_type'?: io.flow.consumer.invoice.v0.enums.ConsumerInvoiceCustomerType;
|
|
67
|
+
readonly 'estimated_delivery_date'?: string;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
interface ConsumerInvoiceCenterReference {
|
|
71
|
+
readonly 'id': string;
|
|
72
|
+
readonly 'key': string;
|
|
73
|
+
readonly 'name': string;
|
|
74
|
+
readonly 'address': io.flow.common.v0.models.Address;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
interface ConsumerInvoiceDocument {
|
|
78
|
+
readonly 'type': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceDocumentType;
|
|
79
|
+
readonly 'language': string;
|
|
80
|
+
readonly 'url': string;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
interface ConsumerInvoiceForm {
|
|
84
|
+
readonly 'order_number': string;
|
|
85
|
+
readonly 'attributes'?: Record<string, string>;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
interface ConsumerInvoiceFormByOrder {
|
|
89
|
+
readonly 'attributes'?: Record<string, string>;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
interface ConsumerInvoiceLevy {
|
|
93
|
+
readonly 'rate': number;
|
|
94
|
+
readonly 'value': io.flow.common.v0.models.Price;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
interface ConsumerInvoiceLevyForm {
|
|
98
|
+
readonly 'rate': number;
|
|
99
|
+
readonly 'amount': number;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
interface ConsumerInvoiceLineDiscount {
|
|
103
|
+
readonly 'discriminator': 'discount';
|
|
104
|
+
readonly 'price': io.flow.common.v0.models.Price;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
interface ConsumerInvoiceLineDiscountForm {
|
|
108
|
+
readonly 'discriminator': 'discount';
|
|
109
|
+
readonly 'price': number;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
interface ConsumerInvoiceLineItem {
|
|
113
|
+
readonly 'discriminator': 'item';
|
|
114
|
+
readonly 'item': io.flow.common.v0.models.ItemReference;
|
|
115
|
+
readonly 'description': string;
|
|
116
|
+
readonly 'quantity': number;
|
|
117
|
+
readonly 'unit_price': io.flow.common.v0.models.Price;
|
|
118
|
+
readonly 'unit_discount'?: io.flow.common.v0.models.Price;
|
|
119
|
+
readonly 'unit_tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
|
|
120
|
+
readonly 'unit_duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
interface ConsumerInvoiceLineItemForm {
|
|
124
|
+
readonly 'discriminator': 'item';
|
|
125
|
+
readonly 'item_number': string;
|
|
126
|
+
readonly 'quantity': number;
|
|
127
|
+
readonly 'unit_price': number;
|
|
128
|
+
readonly 'unit_discount'?: number;
|
|
129
|
+
readonly 'unit_tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
|
|
130
|
+
readonly 'unit_duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
interface ConsumerInvoiceLineShipping {
|
|
134
|
+
readonly 'discriminator': 'shipping';
|
|
135
|
+
readonly 'price': io.flow.common.v0.models.Price;
|
|
136
|
+
readonly 'discount'?: io.flow.common.v0.models.Price;
|
|
137
|
+
readonly 'tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
|
|
138
|
+
readonly 'duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
interface ConsumerInvoiceLineShippingForm {
|
|
142
|
+
readonly 'discriminator': 'shipping';
|
|
143
|
+
readonly 'price': number;
|
|
144
|
+
readonly 'discount'?: number;
|
|
145
|
+
readonly 'tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
|
|
146
|
+
readonly 'duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
interface ConsumerInvoiceOrderSummary {
|
|
150
|
+
readonly 'id': string;
|
|
151
|
+
readonly 'number': string;
|
|
152
|
+
readonly 'submitted_at': string;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
interface ConsumerInvoicePayment {
|
|
156
|
+
readonly 'date': string;
|
|
157
|
+
readonly 'description': string;
|
|
158
|
+
readonly 'value': io.flow.common.v0.models.Price;
|
|
159
|
+
readonly 'billing_address'?: io.flow.common.v0.models.BillingAddress;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
interface ConsumerInvoiceReference {
|
|
163
|
+
readonly 'id': string;
|
|
164
|
+
readonly 'key': string;
|
|
165
|
+
readonly 'number': string;
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
interface CreditMemo {
|
|
169
|
+
readonly 'id': string;
|
|
170
|
+
readonly 'number'?: string;
|
|
171
|
+
readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
|
|
172
|
+
readonly 'date': string;
|
|
173
|
+
readonly 'key': string;
|
|
174
|
+
readonly 'invoice': io.flow.consumer.invoice.v0.models.ConsumerInvoiceReference;
|
|
175
|
+
readonly 'entity': io.flow.common.v0.models.MerchantOfRecordEntity;
|
|
176
|
+
readonly 'payments': io.flow.consumer.invoice.v0.models.ConsumerInvoicePayment[];
|
|
177
|
+
readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
|
|
178
|
+
readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
|
|
179
|
+
readonly 'attributes': Record<string, string>;
|
|
180
|
+
readonly 'tax_registration'?: io.flow.harmonization.v0.models.TaxRegistration;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
interface CreditMemoForm {
|
|
184
|
+
readonly 'refund_id'?: string;
|
|
185
|
+
readonly 'refund_key'?: string;
|
|
186
|
+
readonly 'refund_identifier'?: string;
|
|
187
|
+
readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLineForm[];
|
|
188
|
+
readonly 'attributes'?: Record<string, string>;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
interface InvoiceExport {
|
|
192
|
+
readonly 'id': string;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
interface InvoiceExportForm {
|
|
196
|
+
readonly 'date_from'?: string;
|
|
197
|
+
readonly 'date_to'?: string;
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
declare namespace io.flow.consumer.invoice.v0.unions {
|
|
202
|
+
type ConsumerInvoiceLine = (io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineItem | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineDiscount | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineShipping);
|
|
203
|
+
type ConsumerInvoiceLineForm = (io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineItemForm | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineDiscountForm | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineShippingForm);
|
|
204
|
+
}
|