@flowio/api-types 0.0.228 → 0.0.229

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.
@@ -1,1138 +0,0 @@
1
- declare namespace io.flow.billing.internal.v0.enums {
2
- type AccountPaymentHoldReason = 'fraudulent' | 'frozen' | 'invalid_bank_account';
3
- type AccountSettingLiabilitiesMethod = 'withholding' | 'transaction';
4
- type AccountType = 'channel' | 'organization';
5
- type AdjustmentTransactionType = 'adjustment' | 'reversal';
6
- type BankPaymentPromiseCompletedMethod = 'credit' | 'time';
7
- type BankPaymentStatusCode = 'scheduled' | 'sent' | 'failed';
8
- type BillingAllocationKey = 'freight_cost' | 'adjustment' | 'vat_deminimis' | 'duty_deminimis' | 'duties_item_price' | 'duties_freight' | 'duties_insurance' | 'vat_item_price' | 'vat_freight' | 'vat_insurance' | 'vat_duties_item_price' | 'vat_duties_freight' | 'vat_duties_insurance' | 'item_price' | 'item_discount' | 'rounding' | 'insurance' | 'shipping' | 'order_discount' | 'subtotal_percent_sales_margin' | 'subtotal_vat_percent_sales_margin' | 'subtotal_duty_percent_sales_margin' | 'vat_subsidy' | 'duty_subsidy' | 'fuel_surcharge' | 'remote_area_surcharge';
9
- type BillingStatementAttachmentKey = 'invoice' | 'statement' | 'consumer_invoice' | 'credit_memo' | 'channel_billed' | 'transactions' | 'virtual_card' | 'tax_remittance' | 'manual' | 'orders' | 'label' | 'order_service' | 'tax' | 'duty' | 'trueup' | 'carrier_charge' | 'all';
10
- type BillingTransactionStatus = 'pending_proof' | 'posted';
11
- type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'reversal' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment' | 'dispute' | 'channel' | 'label' | 'order' | 'channel_billed' | 'tax' | 'duty' | 'trueup' | 'carrier_charge';
12
- type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
13
- type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
14
- type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
15
- type DisputeTransactionType = 'adjustment' | 'dispute';
16
- type DutyTransactionType = 'adjustment' | 'reversal' | 'duty';
17
- type FeesSource = 'settings' | 'authorization_bundle';
18
- type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
19
- type ManualTransactionCategory = 'cancelled_order_refund' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee' | 'bank_payment_failure';
20
- type OrderCancellationInitiatedBy = 'flow' | 'organization';
21
- type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
22
- type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
23
- type ProcessingTransactionType = 'adjustment' | 'reversal' | 'capture' | 'refund' | 'fully_subsidized_order' | 'credit_payment';
24
- type ResponsibleParty = 'flow' | 'organization';
25
- type StatementTransferTransactionLocation = 'transactions_file' | 'summary';
26
- type SubscriptionFrequency = 'yearly' | 'monthly';
27
- type TaxTransactionType = 'adjustment' | 'reversal' | 'tax';
28
- type TransactionPostingMethod = 'time' | 'proof';
29
- type TransferMethod = 'ach';
30
- type TrueupTransactionType = 'adjustment' | 'reversal' | 'trueup';
31
- }
32
-
33
- declare namespace io.flow.billing.internal.v0.models {
34
- interface AccountContact {
35
- readonly 'id': string;
36
- readonly 'email': string;
37
- readonly 'first_name'?: string;
38
- readonly 'last_name'?: string;
39
- readonly 'phone'?: string;
40
- readonly 'account'?: io.flow.billing.internal.v0.models.SimpleAccountReference;
41
- }
42
-
43
- interface AccountContactForm {
44
- readonly 'email': string;
45
- readonly 'first_name'?: string;
46
- readonly 'last_name'?: string;
47
- readonly 'phone'?: string;
48
- }
49
-
50
- interface AccountDepositRule {
51
- readonly 'target': number;
52
- readonly 'rate': number;
53
- }
54
-
55
- interface AccountDepositRuleForm {
56
- readonly 'target': number;
57
- readonly 'rate': number;
58
- }
59
-
60
- interface AccountOrigin {
61
- readonly 'country': string;
62
- }
63
-
64
- interface AccountPaymentHold {
65
- readonly 'id': string;
66
- readonly 'account': io.flow.billing.internal.v0.models.SimpleAccountReference;
67
- readonly 'reason': io.flow.billing.internal.v0.enums.AccountPaymentHoldReason;
68
- }
69
-
70
- interface AccountPaymentHoldForm {
71
- readonly 'account_id': string;
72
- readonly 'reason': io.flow.billing.internal.v0.enums.AccountPaymentHoldReason;
73
- }
74
-
75
- interface AccountProcessingRateForm {
76
- readonly 'query': string;
77
- readonly 'capture': number;
78
- readonly 'refund': number;
79
- readonly 'fraud': number;
80
- }
81
-
82
- interface AccountProcessingRates {
83
- readonly 'id': string;
84
- readonly 'query': string;
85
- readonly 'capture': number;
86
- readonly 'refund': number;
87
- readonly 'fraud': number;
88
- readonly 'position': number;
89
- }
90
-
91
- interface AccountProcessingRatesForm {
92
- readonly 'processing_rates': io.flow.billing.internal.v0.models.AccountProcessingRateForm[];
93
- }
94
-
95
- interface AccountSettingLabelFees {
96
- readonly 'flow'?: io.flow.billing.internal.v0.models.TieredFee;
97
- readonly 'organization'?: io.flow.billing.internal.v0.models.TieredFee;
98
- }
99
-
100
- interface AccountSettings {
101
- readonly 'id': string;
102
- readonly 'days_until_posted': number;
103
- readonly 'logistics': io.flow.billing.internal.v0.enums.ResponsibleParty;
104
- readonly 'include_transaction_created_at': boolean;
105
- readonly 'include_order_exchange_rate': boolean;
106
- readonly 'send_statements_to_flow_ftp_server': boolean;
107
- readonly 'invoicing_terms'?: io.flow.invoice.v0.enums.PaymentTerm;
108
- readonly 'transfer_method'?: io.flow.billing.internal.v0.enums.TransferMethod;
109
- readonly 'b2b_tax_remittance_days'?: number;
110
- readonly 'merchant_of_record_fee'?: number;
111
- readonly 'duty_guarantee_fee'?: number;
112
- readonly 'transfer_fee'?: number;
113
- readonly 'negative_balance_fee'?: number;
114
- readonly 'order_service_fee'?: io.flow.billing.internal.v0.models.TieredFee;
115
- readonly 'label_fees'?: io.flow.billing.internal.v0.models.AccountSettingLabelFees;
116
- readonly 'charge_label_cost_directly': boolean;
117
- readonly 'transaction_posting_method': io.flow.billing.internal.v0.enums.TransactionPostingMethod;
118
- readonly 'statement_transfer_transaction_location': io.flow.billing.internal.v0.enums.StatementTransferTransactionLocation;
119
- readonly 'fees_source': io.flow.billing.internal.v0.enums.FeesSource;
120
- readonly 'require_payment_request': boolean;
121
- readonly 'round_individual_transactions': boolean;
122
- readonly 'liabilities_method': io.flow.billing.internal.v0.enums.AccountSettingLiabilitiesMethod;
123
- readonly 'enable_fee_reversals': boolean;
124
- readonly 'record_reason_for_transactions_pending_payout': boolean;
125
- readonly 'enable_negative_debits': boolean;
126
- }
127
-
128
- interface AccountSource {
129
- readonly 'id': string;
130
- readonly 'type': io.flow.billing.internal.v0.enums.AccountType;
131
- }
132
-
133
- interface AccountStatistics {
134
- readonly 'transfers': io.flow.common.v0.models.Price;
135
- readonly 'balance': io.flow.common.v0.models.Price;
136
- readonly 'pending': io.flow.common.v0.models.Price;
137
- }
138
-
139
- interface AccountSummary {
140
- readonly 'id': string;
141
- readonly 'currency': string;
142
- readonly 'source': io.flow.billing.internal.v0.models.AccountSource;
143
- }
144
-
145
- interface AdjustmentAmountFixed {
146
- readonly 'discriminator': 'fixed';
147
- readonly 'amount': io.flow.common.v0.models.Money;
148
- }
149
-
150
- interface AdjustmentAmountPercentage {
151
- readonly 'discriminator': 'percentage';
152
- readonly 'percentage': number;
153
- }
154
-
155
- interface AdjustmentDetailsAmountFixed {
156
- readonly 'amount': io.flow.common.v0.models.Money;
157
- }
158
-
159
- interface AdjustmentDetailsAmountPercentage {
160
- readonly 'percentage': number;
161
- }
162
-
163
- interface AdjustmentDetailsProcessingTransaction {
164
- readonly 'discriminator': 'processing_transaction';
165
- readonly 'withholdings'?: io.flow.billing.internal.v0.models.AdjustmentDetailsProcessingTransactionWithholding[];
166
- readonly 'fees'?: io.flow.billing.internal.v0.models.AdjustmentDetailsProcessingTransactionFee[];
167
- }
168
-
169
- interface AdjustmentDetailsProcessingTransactionFee {
170
- readonly 'type': io.flow.billing.v0.enums.FeeDeductionType;
171
- readonly 'amount': io.flow.billing.internal.v0.unions.AdjustmentAmount;
172
- }
173
-
174
- interface AdjustmentDetailsProcessingTransactionWithholding {
175
- readonly 'type': io.flow.billing.v0.enums.WithholdingDeductionType;
176
- readonly 'amount': io.flow.billing.internal.v0.unions.AdjustmentAmount;
177
- }
178
-
179
- interface BankAccountReference {
180
- readonly 'id': string;
181
- }
182
-
183
- interface BankPayment {
184
- readonly 'id': string;
185
- readonly 'key': string;
186
- readonly 'account': io.flow.billing.v0.models.AccountReference;
187
- readonly 'reference'?: string;
188
- readonly 'sent_on'?: string;
189
- readonly 'status': io.flow.billing.v0.unions.PayoutStatus;
190
- readonly 'expected_delivery_by'?: string;
191
- readonly 'attributes'?: Record<string, string>;
192
- readonly 'total': io.flow.common.v0.models.Price;
193
- }
194
-
195
- interface BankPaymentForm {
196
- readonly 'account_id': string;
197
- readonly 'reference'?: string;
198
- readonly 'sent_on'?: string;
199
- readonly 'expected_delivery_by'?: string;
200
- readonly 'amount': number;
201
- readonly 'currency': string;
202
- readonly 'transfer_transaction_ids': string[];
203
- readonly 'attributes'?: Record<string, string>;
204
- }
205
-
206
- interface BankPaymentOrder {
207
- readonly 'id': string;
208
- readonly 'payment': io.flow.billing.internal.v0.models.BankPaymentReference;
209
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
210
- }
211
-
212
- interface BankPaymentReference {
213
- readonly 'id': string;
214
- }
215
-
216
- interface BankPaymentStatusForm {
217
- readonly 'code': io.flow.billing.internal.v0.enums.BankPaymentStatusCode;
218
- readonly 'failure_reason'?: io.flow.billing.v0.enums.PayoutStatusFailureCode;
219
- }
220
-
221
- interface BankPaymentStatusImport {
222
- readonly 'id': string;
223
- readonly 'created_at': string;
224
- readonly 'result'?: io.flow.billing.internal.v0.models.BankPaymentStatusImportResult;
225
- }
226
-
227
- interface BankPaymentStatusImportForm {
228
- readonly 'forms': io.flow.billing.internal.v0.models.BankPaymentStatusSingleForm[];
229
- }
230
-
231
- interface BankPaymentStatusImportResult {
232
- readonly 'processed_at': string;
233
- readonly 'number_lines_successful': number;
234
- readonly 'number_lines_with_errors': number;
235
- readonly 'errors_url'?: string;
236
- }
237
-
238
- interface BankPaymentStatusSentImportForm {
239
- readonly 'payment_ids': string[];
240
- }
241
-
242
- interface BankPaymentStatusSingleForm {
243
- readonly 'payment_id': string;
244
- readonly 'code': io.flow.billing.internal.v0.enums.BankPaymentStatusCode;
245
- readonly 'failure_reason'?: io.flow.billing.v0.enums.PayoutStatusFailureCode;
246
- }
247
-
248
- interface BillingAuthorizationReference {
249
- readonly 'id': string;
250
- }
251
-
252
- interface BillingInvoiceSummary {
253
- readonly 'id': string;
254
- readonly 'url': string;
255
- }
256
-
257
- interface BillingLabelSummary {
258
- readonly 'id': string;
259
- readonly 'flow_tracking_number': string;
260
- readonly 'carrier_id': string;
261
- readonly 'carrier_tracking_number': string;
262
- }
263
-
264
- interface BillingLabelTrackingSummaryReference {
265
- readonly 'id': string;
266
- }
267
-
268
- interface BillingOrderDestination {
269
- readonly 'city'?: string;
270
- readonly 'province'?: string;
271
- readonly 'postal'?: string;
272
- readonly 'country': string;
273
- }
274
-
275
- interface BillingOrderSummary {
276
- readonly 'number': string;
277
- readonly 'submitted_at': string;
278
- readonly 'primary_identifier'?: string;
279
- readonly 'identifiers'?: Record<string, string>;
280
- readonly 'destination'?: io.flow.billing.internal.v0.models.BillingOrderDestination;
281
- }
282
-
283
- interface BillingOrderTransactionOrderReference {
284
- readonly 'organization': io.flow.common.v0.models.OrganizationReference;
285
- readonly 'number': string;
286
- }
287
-
288
- interface BillingOrganizationProcessingRates {
289
- readonly 'id': string;
290
- readonly 'query': string;
291
- readonly 'capture': number;
292
- readonly 'refund': number;
293
- readonly 'fraud': number;
294
- readonly 'position': number;
295
- }
296
-
297
- interface BillingOrganizationSettings {
298
- readonly 'id': string;
299
- readonly 'days_until_posted': number;
300
- readonly 'logistics': io.flow.billing.internal.v0.enums.ResponsibleParty;
301
- readonly 'include_transaction_created_at': boolean;
302
- readonly 'include_order_exchange_rate': boolean;
303
- readonly 'send_statements_to_flow_ftp_server': boolean;
304
- readonly 'invoicing_terms'?: io.flow.invoice.v0.enums.PaymentTerm;
305
- readonly 'transfer_method'?: io.flow.billing.internal.v0.enums.TransferMethod;
306
- readonly 'b2b_tax_remittance_days'?: number;
307
- readonly 'mor_fee'?: number;
308
- readonly 'duty_guarantee_fee'?: number;
309
- readonly 'negative_balance_fee'?: number;
310
- readonly 'order_service_fee'?: io.flow.billing.internal.v0.models.TieredFee;
311
- readonly 'label_fee'?: io.flow.billing.internal.v0.models.TieredFee;
312
- }
313
-
314
- interface BillingSandboxSetup {
315
- readonly 'description': string;
316
- }
317
-
318
- interface BillingStatementAttachment {
319
- readonly 'key': io.flow.billing.internal.v0.enums.BillingStatementAttachmentKey;
320
- readonly 'name': string;
321
- readonly 'url': string;
322
- }
323
-
324
- interface BillingStatementReference {
325
- readonly 'id': string;
326
- }
327
-
328
- interface BillingStatementSummary {
329
- readonly 'id': string;
330
- readonly 'account': io.flow.billing.v0.models.AccountReference;
331
- readonly 'period': io.flow.common.v0.models.DatetimeRange;
332
- readonly 'totals': io.flow.billing.internal.v0.models.BillingStatementTotals;
333
- readonly 'attachments': io.flow.billing.internal.v0.models.BillingStatementAttachment[];
334
- }
335
-
336
- interface BillingStatementTotals {
337
- readonly 'starting_balance': io.flow.common.v0.models.Price;
338
- readonly 'subscription': io.flow.common.v0.models.Price;
339
- readonly 'transfer': io.flow.common.v0.models.Price;
340
- readonly 'invoice': io.flow.common.v0.models.Price;
341
- readonly 'manual': io.flow.common.v0.models.Price;
342
- readonly 'adjustment': io.flow.common.v0.models.Price;
343
- readonly 'capture': io.flow.common.v0.models.Price;
344
- readonly 'refund': io.flow.common.v0.models.Price;
345
- readonly 'reversal': io.flow.common.v0.models.Price;
346
- readonly 'credit_payment': io.flow.common.v0.models.Price;
347
- readonly 'fully_subsidized_order': io.flow.common.v0.models.Price;
348
- readonly 'virtual_card_capture': io.flow.common.v0.models.Price;
349
- readonly 'virtual_card_refund': io.flow.common.v0.models.Price;
350
- readonly 'tax_remittance': io.flow.common.v0.models.Price;
351
- readonly 'dispute': io.flow.common.v0.models.Price;
352
- readonly 'channel': io.flow.common.v0.models.Price;
353
- readonly 'label': io.flow.common.v0.models.Price;
354
- readonly 'order': io.flow.common.v0.models.Price;
355
- readonly 'channel_billed': io.flow.common.v0.models.Price;
356
- readonly 'tax': io.flow.common.v0.models.Price;
357
- readonly 'duty': io.flow.common.v0.models.Price;
358
- readonly 'trueup': io.flow.common.v0.models.Price;
359
- readonly 'carrier_charge': io.flow.common.v0.models.Price;
360
- readonly 'ending_balance': io.flow.common.v0.models.Price;
361
- }
362
-
363
- interface BillingTransaction {
364
- readonly 'id': string;
365
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
366
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
367
- readonly 'posted_at'?: string;
368
- readonly 'value': io.flow.common.v0.models.Price;
369
- readonly 'description': string;
370
- readonly 'created_at': string;
371
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
372
- }
373
-
374
- interface CarrierChargeReference {
375
- readonly 'id': string;
376
- }
377
-
378
- interface CarrierChargeTransaction {
379
- readonly 'discriminator': 'carrier_charge_transaction';
380
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
381
- readonly 'label_created_at': string;
382
- readonly 'outbound_carrier_charge_id'?: io.flow.billing.internal.v0.models.CarrierChargeReference;
383
- readonly 'id': string;
384
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
385
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
386
- readonly 'posted_at'?: string;
387
- readonly 'value': io.flow.common.v0.models.Price;
388
- readonly 'description': string;
389
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
390
- readonly 'created_at': string;
391
- }
392
-
393
- interface ChannelAccount {
394
- readonly 'channel': io.flow.common.v0.models.ChannelReference;
395
- readonly 'id': string;
396
- readonly 'key'?: string;
397
- readonly 'origin'?: io.flow.billing.internal.v0.models.AccountOrigin;
398
- readonly 'currency': string;
399
- readonly 'updated_at': string;
400
- readonly 'timezone': io.flow.reference.v0.models.Timezone;
401
- readonly 'payment_schedule': io.flow.common.v0.unions.RepeatSchedule;
402
- readonly 'payment_conditions'?: string;
403
- readonly 'deposit_rule'?: io.flow.billing.internal.v0.models.AccountDepositRule;
404
- readonly 'center_key'?: string;
405
- readonly 'statistics': io.flow.billing.internal.v0.models.AccountStatistics;
406
- readonly 'next_statement': io.flow.billing.internal.v0.models.NextBillingStatement;
407
- readonly 'bank_account'?: io.flow.billing.internal.v0.models.BankAccountReference;
408
- readonly 'created_at': string;
409
- }
410
-
411
- interface ChannelBilledTransaction {
412
- readonly 'discriminator': 'channel_billed_transaction';
413
- readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
414
- readonly 'id': string;
415
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
416
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
417
- readonly 'posted_at'?: string;
418
- readonly 'value': io.flow.common.v0.models.Price;
419
- readonly 'description': string;
420
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
421
- readonly 'created_at': string;
422
- }
423
-
424
- interface ChannelBilledTransactionPair {
425
- readonly 'id': string;
426
- readonly 'key': string;
427
- readonly 'attributes'?: Record<string, string>;
428
- readonly 'organization_transaction': io.flow.billing.internal.v0.models.ChannelBilledTransactionReference;
429
- readonly 'channel_transaction': io.flow.billing.internal.v0.models.ChannelBilledTransactionReference;
430
- }
431
-
432
- interface ChannelBilledTransactionPairForm {
433
- readonly 'channel_id': string;
434
- readonly 'organization_id': string;
435
- readonly 'amount': number;
436
- readonly 'currency': string;
437
- readonly 'description': string;
438
- readonly 'order_number'?: string;
439
- readonly 'attributes'?: Record<string, string>;
440
- }
441
-
442
- interface ChannelBilledTransactionReference {
443
- readonly 'id': string;
444
- }
445
-
446
- interface ChannelBillingStatement {
447
- readonly 'id': string;
448
- readonly 'account': io.flow.billing.v0.models.AccountReference;
449
- readonly 'period': io.flow.common.v0.models.DatetimeRange;
450
- readonly 'totals': io.flow.billing.internal.v0.models.BillingStatementTotals;
451
- readonly 'attachments': io.flow.billing.internal.v0.models.BillingStatementAttachment[];
452
- }
453
-
454
- interface ChannelRateMetadataIdentity {
455
- readonly 'discriminator': 'channel_rate_metadata_identity';
456
- readonly 'currency': string;
457
- }
458
-
459
- interface ChannelRateMetadataRate {
460
- readonly 'discriminator': 'channel_rate_metadata_rate';
461
- readonly 'id': string;
462
- readonly 'base': string;
463
- readonly 'target': string;
464
- readonly 'spot_rate': number;
465
- readonly 'flow_margin': number;
466
- readonly 'flow_rate': number;
467
- readonly 'journal_id'?: string;
468
- readonly 'effective_at': string;
469
- readonly 'timestamp'?: string;
470
- }
471
-
472
- interface ChannelTransaction {
473
- readonly 'discriminator': 'channel_transaction';
474
- readonly 'transaction': io.flow.billing.internal.v0.models.TransactionReference;
475
- readonly 'fees': io.flow.billing.internal.v0.models.Fee[];
476
- readonly 'id': string;
477
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
478
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
479
- readonly 'posted_at'?: string;
480
- readonly 'value': io.flow.common.v0.models.Price;
481
- readonly 'description': string;
482
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
483
- readonly 'created_at': string;
484
- }
485
-
486
- interface ChannelTransactionRate {
487
- readonly 'from': string;
488
- readonly 'to': string;
489
- readonly 'value': number;
490
- readonly 'timestamp': string;
491
- }
492
-
493
- interface CliLogEntry {
494
- readonly 'id': string;
495
- readonly 'user': io.flow.common.v0.models.UserReference;
496
- readonly 'task': string;
497
- }
498
-
499
- interface CliLogEntryForm {
500
- readonly 'user_id': string;
501
- readonly 'task': string;
502
- }
503
-
504
- interface Components {
505
- readonly 'vat': io.flow.common.v0.models.Price;
506
- readonly 'duty': io.flow.common.v0.models.Price;
507
- readonly 'freight': io.flow.common.v0.models.Price;
508
- readonly 'insurance': io.flow.common.v0.models.Price;
509
- }
510
-
511
- interface Discount {
512
- readonly 'amount': number;
513
- readonly 'description'?: string;
514
- }
515
-
516
- interface DisputeTransaction {
517
- readonly 'discriminator': 'dispute_transaction';
518
- readonly 'authorization': io.flow.payment.v0.models.AuthorizationReference;
519
- readonly 'id': string;
520
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
521
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
522
- readonly 'posted_at'?: string;
523
- readonly 'value': io.flow.common.v0.models.Price;
524
- readonly 'description': string;
525
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
526
- readonly 'created_at': string;
527
- }
528
-
529
- interface DutyTransaction {
530
- readonly 'discriminator': 'duty_transaction';
531
- readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
532
- readonly 'id': string;
533
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
534
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
535
- readonly 'posted_at'?: string;
536
- readonly 'value': io.flow.common.v0.models.Price;
537
- readonly 'description': string;
538
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
539
- readonly 'created_at': string;
540
- }
541
-
542
- interface EmailForm {
543
- readonly 'to': string[];
544
- readonly 'cc'?: string[];
545
- readonly 'bcc'?: string[];
546
- }
547
-
548
- interface ExplicitStatement {
549
- readonly 'id': string;
550
- readonly 'statement': io.flow.billing.internal.v0.models.BillingStatementReference;
551
- readonly 'reason': string;
552
- }
553
-
554
- interface ExplicitStatementFormAllPendingPostedTransactions {
555
- readonly 'discriminator': 'all_pending_posted_transactions';
556
- readonly 'account_id': string;
557
- readonly 'reason': string;
558
- }
559
-
560
- interface ExplicitStatementFormTransactionIds {
561
- readonly 'discriminator': 'transaction_ids';
562
- readonly 'account_id': string;
563
- readonly 'reason': string;
564
- readonly 'transaction_ids': string[];
565
- }
566
-
567
- interface ExternalFulfillmentProof {
568
- readonly 'id': string;
569
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
570
- readonly 'responsible_party': io.flow.billing.internal.v0.enums.ResponsibleParty;
571
- readonly 'tracking': io.flow.billing.internal.v0.models.ExternalFulfillmentProofTracking[];
572
- }
573
-
574
- interface ExternalFulfillmentProofForm {
575
- readonly 'responsible_party': io.flow.billing.internal.v0.enums.ResponsibleParty;
576
- readonly 'tracking'?: io.flow.billing.internal.v0.models.ExternalFulfillmentProofTrackingForm[];
577
- }
578
-
579
- interface ExternalFulfillmentProofTracking {
580
- readonly 'carrier_id'?: string;
581
- readonly 'service_id'?: string;
582
- readonly 'carrier_tracking_number'?: string;
583
- readonly 'fulfilled_via_replacement_order'?: boolean;
584
- }
585
-
586
- interface ExternalFulfillmentProofTrackingForm {
587
- readonly 'carrier_id'?: string;
588
- readonly 'service_id'?: string;
589
- readonly 'carrier_tracking_number'?: string;
590
- readonly 'fulfilled_via_replacement_order'?: boolean;
591
- }
592
-
593
- interface Fee {
594
- readonly 'value': io.flow.common.v0.models.Price;
595
- readonly 'description'?: string;
596
- }
597
-
598
- interface Fees {
599
- readonly 'processing'?: io.flow.billing.internal.v0.models.Fee;
600
- readonly 'rate_lock': io.flow.billing.internal.v0.models.Fee;
601
- readonly 'mor'?: io.flow.billing.internal.v0.models.Fee;
602
- readonly 'fx'?: io.flow.billing.internal.v0.models.Fee;
603
- readonly 'duty_guarantee'?: io.flow.billing.internal.v0.models.Fee;
604
- readonly 'transfer'?: io.flow.billing.internal.v0.models.Fee;
605
- readonly 'negative_balance'?: io.flow.billing.internal.v0.models.Fee;
606
- }
607
-
608
- interface FinanceBankAccount {
609
- readonly 'id': string;
610
- readonly 'accounts': io.flow.billing.internal.v0.models.AccountSummary[];
611
- readonly 'last4': string;
612
- readonly 'info': io.flow.billing.bank.account.v0.unions.BankAccountInfo;
613
- readonly 'owner'?: io.flow.billing.internal.v0.models.FinanceBankAccountOwner;
614
- }
615
-
616
- interface FinanceBankAccountOwner {
617
- readonly 'name': string;
618
- }
619
-
620
- interface FinanceBankPayment {
621
- readonly 'id': string;
622
- readonly 'account': io.flow.billing.internal.v0.models.AccountSummary;
623
- readonly 'last4'?: string;
624
- readonly 'info'?: io.flow.billing.bank.account.v0.unions.BankAccountInfo;
625
- readonly 'owner'?: io.flow.billing.internal.v0.models.FinanceBankAccountOwner;
626
- }
627
-
628
- interface FlowAccount {
629
- readonly 'source': io.flow.billing.internal.v0.models.AccountSource;
630
- readonly 'id': string;
631
- readonly 'key'?: string;
632
- readonly 'origin'?: io.flow.billing.internal.v0.models.AccountOrigin;
633
- readonly 'currency': string;
634
- readonly 'updated_at': string;
635
- readonly 'timezone': io.flow.reference.v0.models.Timezone;
636
- readonly 'payment_schedule': io.flow.common.v0.unions.RepeatSchedule;
637
- readonly 'payment_conditions'?: string;
638
- readonly 'deposit_rule'?: io.flow.billing.internal.v0.models.AccountDepositRule;
639
- readonly 'center_key'?: string;
640
- readonly 'statistics': io.flow.billing.internal.v0.models.AccountStatistics;
641
- readonly 'next_statement': io.flow.billing.internal.v0.models.NextBillingStatement;
642
- readonly 'bank_account'?: io.flow.billing.internal.v0.models.BankAccountReference;
643
- readonly 'created_at': string;
644
- }
645
-
646
- interface FlowBillingStatement {
647
- readonly 'id': string;
648
- readonly 'account': io.flow.billing.v0.models.AccountReference;
649
- readonly 'period': io.flow.common.v0.models.DatetimeRange;
650
- readonly 'totals': io.flow.billing.internal.v0.models.BillingStatementTotals;
651
- readonly 'attachments': io.flow.billing.internal.v0.models.BillingStatementAttachment[];
652
- }
653
-
654
- interface FxFee {
655
- readonly 'base': io.flow.common.v0.models.Money;
656
- readonly 'local': io.flow.common.v0.models.Money;
657
- }
658
-
659
- interface FxRevenueRecognition {
660
- readonly 'id': string;
661
- readonly 'organization': io.flow.billing.internal.v0.models.FxRevenueRecognitionOrganization;
662
- readonly 'account': io.flow.billing.internal.v0.models.FxRevenueRecognitionAccount;
663
- readonly 'fx': io.flow.billing.internal.v0.models.FxFee;
664
- readonly 'spot_rate': io.flow.billing.internal.v0.models.FxRevenueRecognitionRate;
665
- readonly 'created_at': string;
666
- readonly 'order': io.flow.billing.internal.v0.models.FxRevenueRecognitionOrder;
667
- readonly 'merchant_of_record': io.flow.common.v0.enums.MerchantOfRecord;
668
- readonly 'source': io.flow.billing.internal.v0.models.FxRevenueRecognitionSource;
669
- readonly 'reporting_date'?: string;
670
- }
671
-
672
- interface FxRevenueRecognitionAccount {
673
- readonly 'value': io.flow.common.v0.models.Money;
674
- readonly 'spot_rate': io.flow.billing.internal.v0.models.FxRevenueRecognitionAccountRate;
675
- }
676
-
677
- interface FxRevenueRecognitionAccountRate {
678
- readonly 'value': number;
679
- }
680
-
681
- interface FxRevenueRecognitionOrder {
682
- readonly 'number': string;
683
- readonly 'submitted_at': string;
684
- }
685
-
686
- interface FxRevenueRecognitionOrganization {
687
- readonly 'id': string;
688
- }
689
-
690
- interface FxRevenueRecognitionRate {
691
- readonly 'value': number;
692
- readonly 'margin': number;
693
- readonly 'timestamp': string;
694
- }
695
-
696
- interface FxRevenueRecognitionSource {
697
- readonly 'id': string;
698
- readonly 'local': io.flow.common.v0.models.Money;
699
- readonly 'transaction_created_at': string;
700
- }
701
-
702
- interface InvoiceTransaction {
703
- readonly 'discriminator': 'invoice_transaction';
704
- readonly 'invoice': io.flow.invoice.v0.models.Invoice;
705
- readonly 'id': string;
706
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
707
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
708
- readonly 'posted_at'?: string;
709
- readonly 'value': io.flow.common.v0.models.Price;
710
- readonly 'description': string;
711
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
712
- readonly 'created_at': string;
713
- }
714
-
715
- interface LabelTransaction {
716
- readonly 'discriminator': 'label_transaction';
717
- readonly 'label': io.flow.billing.internal.v0.models.BillingLabelSummary;
718
- readonly 'tracking': io.flow.billing.internal.v0.models.BillingLabelTrackingSummaryReference;
719
- readonly 'gross_value': io.flow.common.v0.models.Price;
720
- readonly 'discount': io.flow.billing.internal.v0.models.Discount;
721
- readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
722
- readonly 'id': string;
723
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
724
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
725
- readonly 'posted_at'?: string;
726
- readonly 'value': io.flow.common.v0.models.Price;
727
- readonly 'description': string;
728
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
729
- readonly 'created_at': string;
730
- }
731
-
732
- interface LostChargeback {
733
- readonly 'id': string;
734
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
735
- }
736
-
737
- interface MainTransaction {
738
- readonly 'id': string;
739
- readonly 'account': io.flow.billing.v0.models.AccountReference;
740
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
741
- readonly 'value': io.flow.common.v0.models.Price;
742
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
743
- readonly 'posted_at'?: string;
744
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
745
- readonly 'created_at': string;
746
- readonly 'original_at'?: string;
747
- }
748
-
749
- interface ManualTransaction {
750
- readonly 'discriminator': 'manual_transaction';
751
- readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
752
- readonly 'original_transaction'?: io.flow.billing.internal.v0.models.TransactionReference;
753
- readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
754
- readonly 'attributes'?: Record<string, string>;
755
- readonly 'id': string;
756
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
757
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
758
- readonly 'posted_at'?: string;
759
- readonly 'value': io.flow.common.v0.models.Price;
760
- readonly 'description': string;
761
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
762
- readonly 'created_at': string;
763
- }
764
-
765
- interface ManualTransactionForm {
766
- readonly 'amount': number;
767
- readonly 'currency'?: string;
768
- readonly 'description': string;
769
- readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
770
- readonly 'order'?: io.flow.billing.internal.v0.models.ManualTransactionFormOrder;
771
- readonly 'original_transaction_id'?: string;
772
- readonly 'attributes'?: Record<string, string>;
773
- }
774
-
775
- interface ManualTransactionFormOrder {
776
- readonly 'organization_id': string;
777
- readonly 'number': string;
778
- }
779
-
780
- interface NextBillingStatement {
781
- readonly 'date': string;
782
- readonly 'amount': io.flow.common.v0.models.Price;
783
- readonly 'conditions'?: string;
784
- }
785
-
786
- interface OrderCancellation {
787
- readonly 'id': string;
788
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
789
- readonly 'evidence': io.flow.billing.internal.v0.unions.OrderCancellationEvidence;
790
- }
791
-
792
- interface OrderCancellationEvidenceFullyRefundedNotFulfilled {
793
- readonly 'discriminator': 'fully_refunded_not_fulfilled';
794
- readonly 'placeholder'?: string;
795
- }
796
-
797
- interface OrderCancellationEvidenceManual {
798
- readonly 'discriminator': 'manual';
799
- readonly 'description': string;
800
- }
801
-
802
- interface OrderCancellationEvidenceReturnToSender {
803
- readonly 'discriminator': 'return_to_sender';
804
- readonly 'initiated_by': io.flow.billing.internal.v0.enums.OrderCancellationInitiatedBy;
805
- }
806
-
807
- interface OrderCancellationForm {
808
- readonly 'evidence': io.flow.billing.internal.v0.unions.OrderCancellationEvidence;
809
- }
810
-
811
- interface OrderTransaction {
812
- readonly 'discriminator': 'order_transaction';
813
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
814
- readonly 'id': string;
815
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
816
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
817
- readonly 'posted_at'?: string;
818
- readonly 'value': io.flow.common.v0.models.Price;
819
- readonly 'description': string;
820
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
821
- readonly 'created_at': string;
822
- }
823
-
824
- interface OrganizationAccount {
825
- readonly 'organization': io.flow.common.v0.models.OrganizationReference;
826
- readonly 'id': string;
827
- readonly 'key'?: string;
828
- readonly 'origin'?: io.flow.billing.internal.v0.models.AccountOrigin;
829
- readonly 'currency': string;
830
- readonly 'updated_at': string;
831
- readonly 'timezone': io.flow.reference.v0.models.Timezone;
832
- readonly 'payment_schedule': io.flow.common.v0.unions.RepeatSchedule;
833
- readonly 'payment_conditions'?: string;
834
- readonly 'deposit_rule'?: io.flow.billing.internal.v0.models.AccountDepositRule;
835
- readonly 'center_key'?: string;
836
- readonly 'statistics': io.flow.billing.internal.v0.models.AccountStatistics;
837
- readonly 'next_statement': io.flow.billing.internal.v0.models.NextBillingStatement;
838
- readonly 'bank_account'?: io.flow.billing.internal.v0.models.BankAccountReference;
839
- readonly 'created_at': string;
840
- }
841
-
842
- interface OrganizationBillingStatement {
843
- readonly 'id': string;
844
- readonly 'account': io.flow.billing.v0.models.AccountReference;
845
- readonly 'period': io.flow.common.v0.models.DatetimeRange;
846
- readonly 'totals': io.flow.billing.internal.v0.models.BillingStatementTotals;
847
- readonly 'attachments': io.flow.billing.internal.v0.models.BillingStatementAttachment[];
848
- }
849
-
850
- interface PayoutStatusCounts {
851
- readonly 'scheduled': number;
852
- readonly 'sent': number;
853
- readonly 'failed': number;
854
- }
855
-
856
- interface PendingBankPayment {
857
- readonly 'id': string;
858
- readonly 'account': io.flow.billing.internal.v0.models.AccountSummary;
859
- readonly 'total': io.flow.common.v0.models.Price;
860
- readonly 'details': io.flow.billing.internal.v0.models.PendingBankPaymentDetail[];
861
- }
862
-
863
- interface PendingBankPaymentDetail {
864
- readonly 'transaction': io.flow.billing.internal.v0.models.TransactionReference;
865
- readonly 'statement': io.flow.billing.internal.v0.models.BillingStatementReference;
866
- }
867
-
868
- interface PlatformFeeChange {
869
- readonly 'organization_id': string;
870
- readonly 'key': string;
871
- readonly 'platform_fee': io.flow.billing.internal.v0.unions.PlatformFee;
872
- readonly 'starts_at': string;
873
- }
874
-
875
- interface PlatformFeeChangeForm {
876
- readonly 'platform_fee': io.flow.billing.internal.v0.unions.PlatformFee;
877
- readonly 'starts_at': string;
878
- }
879
-
880
- interface PlatformFeeDisabled {
881
- readonly 'discriminator': 'platform_fee_disabled';
882
- readonly 'attributes'?: Record<string, string>;
883
- }
884
-
885
- interface PlatformFeeFlat {
886
- readonly 'discriminator': 'platform_fee_flat';
887
- readonly 'amount': number;
888
- readonly 'currency': string;
889
- readonly 'frequency': io.flow.billing.internal.v0.enums.SubscriptionFrequency;
890
- }
891
-
892
- interface PlatformFeePause {
893
- readonly 'discriminator': 'platform_fee_pause';
894
- readonly 'attributes'?: Record<string, string>;
895
- }
896
-
897
- interface PlatformFeePercentage {
898
- readonly 'discriminator': 'platform_fee_percentage';
899
- readonly 'tiers': io.flow.billing.internal.v0.models.PlatformFeePercentageTier[];
900
- }
901
-
902
- interface PlatformFeePercentageTier {
903
- readonly 'minimum_amount_base': number;
904
- readonly 'rate': number;
905
- }
906
-
907
- interface ProcessingTransaction {
908
- readonly 'discriminator': 'processing_transaction';
909
- readonly 'merchant_of_record': io.flow.common.v0.enums.MerchantOfRecord;
910
- readonly 'logistics_responsibility': io.flow.billing.internal.v0.enums.ResponsibleParty[];
911
- readonly 'original_at'?: string;
912
- readonly 'reference': string;
913
- readonly 'psp_reference_id': string;
914
- readonly 'reference_id': string;
915
- readonly 'reference_key': string;
916
- readonly 'primary_identifier'?: string;
917
- readonly 'payment_method': string;
918
- readonly 'original': io.flow.common.v0.models.PriceWithBase;
919
- readonly 'original_base_at_spot_rate'?: io.flow.common.v0.models.Price;
920
- readonly 'fees': io.flow.billing.internal.v0.models.Fees;
921
- readonly 'components'?: io.flow.billing.internal.v0.models.Components;
922
- readonly 'withholdings': io.flow.billing.internal.v0.models.Components;
923
- readonly 'parent_transaction_id'?: string;
924
- readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderSummary;
925
- readonly 'spot_rate': number;
926
- readonly 'flow_rate': number;
927
- readonly 'flow_margin': number;
928
- readonly 'revenue_share'?: io.flow.common.v0.models.Price;
929
- readonly 'id': string;
930
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
931
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
932
- readonly 'posted_at'?: string;
933
- readonly 'value': io.flow.common.v0.models.Price;
934
- readonly 'description': string;
935
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
936
- readonly 'created_at': string;
937
- }
938
-
939
- interface ProcessingTransactionReference {
940
- readonly 'id': string;
941
- }
942
-
943
- interface ProofOfPostingExternallyFulfilled {
944
- readonly 'discriminator': 'external';
945
- readonly 'external_fulfillment_proof_id': string;
946
- }
947
-
948
- interface ProofOfPostingFulfilled {
949
- readonly 'discriminator': 'fulfilled';
950
- readonly 'label_tracking_summary_id': string;
951
- }
952
-
953
- interface ProofOfPostingOrderCancellation {
954
- readonly 'discriminator': 'order_cancellation';
955
- readonly 'order_cancellation_id': string;
956
- }
957
-
958
- interface ProofOfPostingOrderCombinedShipment {
959
- readonly 'discriminator': 'order_combined_shipment';
960
- readonly 'order_combined_shipment_id': string;
961
- }
962
-
963
- interface ProofOfPostingShippingNotification {
964
- readonly 'discriminator': 'shipping_notification';
965
- readonly 'shipping_notification_id': string;
966
- }
967
-
968
- interface ProofOfPostingTimeElapsed {
969
- readonly 'discriminator': 'time_elapsed';
970
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
971
- readonly 'created_at': string;
972
- }
973
-
974
- interface SimpleAccountReference {
975
- readonly 'id': string;
976
- }
977
-
978
- interface SpotRateMetadataIdentity {
979
- readonly 'discriminator': 'spot_rate_metadata_identity';
980
- readonly 'currency': string;
981
- }
982
-
983
- interface SpotRateMetadataRate {
984
- readonly 'discriminator': 'spot_rate_metadata_rate';
985
- readonly 'id': string;
986
- readonly 'base': string;
987
- readonly 'target': string;
988
- readonly 'value': number;
989
- readonly 'journal_id'?: string;
990
- readonly 'effective_at': string;
991
- readonly 'timestamp'?: string;
992
- }
993
-
994
- interface StandaloneAttachment {
995
- readonly 'id': string;
996
- readonly 'statement': io.flow.billing.internal.v0.models.BillingStatementReference;
997
- readonly 'key': io.flow.billing.internal.v0.enums.BillingStatementAttachmentKey;
998
- readonly 'name': string;
999
- readonly 'url': string;
1000
- }
1001
-
1002
- interface Subscription {
1003
- readonly 'id': string;
1004
- readonly 'organization': string;
1005
- readonly 'value': io.flow.common.v0.models.Price;
1006
- readonly 'frequency': io.flow.billing.internal.v0.enums.SubscriptionFrequency;
1007
- readonly 'starts_at': string;
1008
- readonly 'created_at': string;
1009
- }
1010
-
1011
- interface SubscriptionTransaction {
1012
- readonly 'discriminator': 'subscription_transaction';
1013
- readonly 'period': io.flow.common.v0.models.DatetimeRange;
1014
- readonly 'id': string;
1015
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
1016
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
1017
- readonly 'posted_at'?: string;
1018
- readonly 'value': io.flow.common.v0.models.Price;
1019
- readonly 'description': string;
1020
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
1021
- readonly 'created_at': string;
1022
- }
1023
-
1024
- interface TaxRemittanceTransaction {
1025
- readonly 'discriminator': 'tax_remittance_transaction';
1026
- readonly 'order': io.flow.billing.internal.v0.models.BillingOrderSummary;
1027
- readonly 'invoice': io.flow.billing.internal.v0.models.BillingInvoiceSummary;
1028
- readonly 'id': string;
1029
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
1030
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
1031
- readonly 'posted_at'?: string;
1032
- readonly 'value': io.flow.common.v0.models.Price;
1033
- readonly 'description': string;
1034
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
1035
- readonly 'created_at': string;
1036
- }
1037
-
1038
- interface TaxTransaction {
1039
- readonly 'discriminator': 'tax_transaction';
1040
- readonly 'order'?: io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
1041
- readonly 'id': string;
1042
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
1043
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
1044
- readonly 'posted_at'?: string;
1045
- readonly 'value': io.flow.common.v0.models.Price;
1046
- readonly 'description': string;
1047
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
1048
- readonly 'created_at': string;
1049
- }
1050
-
1051
- interface TieredFee {
1052
- readonly 'currency': string;
1053
- readonly 'tiers': io.flow.billing.internal.v0.models.TieredFeeTier[];
1054
- }
1055
-
1056
- interface TieredFeeTier {
1057
- readonly 'count': number;
1058
- readonly 'amount': number;
1059
- }
1060
-
1061
- interface TransactionAdjustment {
1062
- readonly 'id': string;
1063
- readonly 'original_transaction': io.flow.billing.internal.v0.models.TransactionReference;
1064
- readonly 'adjustment_transaction'?: io.flow.billing.internal.v0.models.TransactionReference;
1065
- readonly 'description': string;
1066
- readonly 'details': io.flow.billing.internal.v0.unions.AdjustmentDetails;
1067
- }
1068
-
1069
- interface TransactionAdjustmentForm {
1070
- readonly 'original_transaction_id': string;
1071
- readonly 'description': string;
1072
- readonly 'details': io.flow.billing.internal.v0.unions.AdjustmentDetails;
1073
- readonly 'type'?: io.flow.billing.internal.v0.enums.AdjustmentTransactionType;
1074
- }
1075
-
1076
- interface TransactionReference {
1077
- readonly 'id': string;
1078
- }
1079
-
1080
- interface TransactionStatement {
1081
- readonly 'id': string;
1082
- readonly 'statement': io.flow.billing.internal.v0.models.BillingStatementReference;
1083
- }
1084
-
1085
- interface TransferTransaction {
1086
- readonly 'discriminator': 'transfer_transaction';
1087
- readonly 'method': io.flow.billing.internal.v0.enums.TransferMethod;
1088
- readonly 'id': string;
1089
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
1090
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
1091
- readonly 'posted_at'?: string;
1092
- readonly 'value': io.flow.common.v0.models.Price;
1093
- readonly 'description': string;
1094
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
1095
- readonly 'created_at': string;
1096
- }
1097
-
1098
- interface TrueupTransaction {
1099
- readonly 'discriminator': 'trueup_transaction';
1100
- readonly 'label_transaction': io.flow.billing.internal.v0.models.TransactionReference;
1101
- readonly 'id': string;
1102
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
1103
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
1104
- readonly 'posted_at'?: string;
1105
- readonly 'value': io.flow.common.v0.models.Price;
1106
- readonly 'description': string;
1107
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
1108
- readonly 'created_at': string;
1109
- }
1110
-
1111
- interface VirtualCardTransaction {
1112
- readonly 'discriminator': 'virtual_card_transaction';
1113
- readonly 'virtual_card': io.flow.payment.v0.models.VirtualCardReference;
1114
- readonly 'authorization': io.flow.payment.v0.models.AuthorizationReference;
1115
- readonly 'original': io.flow.common.v0.models.PriceWithBase;
1116
- readonly 'processing_fee': io.flow.billing.internal.v0.models.Fee;
1117
- readonly 'id': string;
1118
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
1119
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
1120
- readonly 'posted_at'?: string;
1121
- readonly 'value': io.flow.common.v0.models.Price;
1122
- readonly 'description': string;
1123
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
1124
- readonly 'created_at': string;
1125
- }
1126
- }
1127
-
1128
- declare namespace io.flow.billing.internal.v0.unions {
1129
- type AdjustmentAmount = (io.flow.billing.internal.v0.models.AdjustmentAmountPercentage | io.flow.billing.internal.v0.models.AdjustmentAmountFixed);
1130
- type AdjustmentDetails = (io.flow.billing.internal.v0.models.AdjustmentAmountPercentage | io.flow.billing.internal.v0.models.AdjustmentAmountFixed | io.flow.billing.internal.v0.models.AdjustmentDetailsProcessingTransaction);
1131
- type ChannelRateMetadata = (io.flow.billing.internal.v0.models.ChannelRateMetadataIdentity | io.flow.billing.internal.v0.models.ChannelRateMetadataRate);
1132
- type ExplicitStatementForm = (io.flow.billing.internal.v0.models.ExplicitStatementFormTransactionIds | io.flow.billing.internal.v0.models.ExplicitStatementFormAllPendingPostedTransactions);
1133
- type OrderCancellationEvidence = (io.flow.billing.internal.v0.models.OrderCancellationEvidenceManual | io.flow.billing.internal.v0.models.OrderCancellationEvidenceFullyRefundedNotFulfilled | io.flow.billing.internal.v0.models.OrderCancellationEvidenceReturnToSender);
1134
- type PlatformFee = (io.flow.billing.internal.v0.models.PlatformFeePause | io.flow.billing.internal.v0.models.PlatformFeeFlat | io.flow.billing.internal.v0.models.PlatformFeePercentage | io.flow.billing.internal.v0.models.PlatformFeeDisabled);
1135
- type ProofOfPosting = (io.flow.billing.internal.v0.models.ProofOfPostingFulfilled | io.flow.billing.internal.v0.models.ProofOfPostingExternallyFulfilled | io.flow.billing.internal.v0.models.ProofOfPostingShippingNotification | io.flow.billing.internal.v0.models.ProofOfPostingOrderCancellation | io.flow.billing.internal.v0.models.ProofOfPostingOrderCombinedShipment | io.flow.billing.internal.v0.models.ProofOfPostingTimeElapsed);
1136
- type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
1137
- type Transaction = (io.flow.billing.internal.v0.models.InvoiceTransaction | io.flow.billing.internal.v0.models.ManualTransaction | io.flow.billing.internal.v0.models.ProcessingTransaction | io.flow.billing.internal.v0.models.SubscriptionTransaction | io.flow.billing.internal.v0.models.TaxRemittanceTransaction | io.flow.billing.internal.v0.models.TransferTransaction | io.flow.billing.internal.v0.models.VirtualCardTransaction | io.flow.billing.internal.v0.models.DisputeTransaction | io.flow.billing.internal.v0.models.ChannelTransaction | io.flow.billing.internal.v0.models.LabelTransaction | io.flow.billing.internal.v0.models.OrderTransaction | io.flow.billing.internal.v0.models.ChannelBilledTransaction | io.flow.billing.internal.v0.models.TaxTransaction | io.flow.billing.internal.v0.models.DutyTransaction | io.flow.billing.internal.v0.models.TrueupTransaction | io.flow.billing.internal.v0.models.CarrierChargeTransaction);
1138
- }