@flowio/api-types 0.0.224 → 0.0.226

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.
@@ -7,8 +7,9 @@ declare namespace io.flow.billing.accounting.v0.models {
7
7
  readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
8
8
  readonly 'sequence_number': number;
9
9
  readonly 'posting_cutoff': string;
10
- readonly 'trigger': io.flow.billing.accounting.v0.unions.FulfillmentTrigger;
10
+ readonly 'trigger'?: io.flow.billing.accounting.v0.unions.FulfillmentTrigger;
11
11
  readonly 'fulfilled_at': string;
12
+ readonly 'carrier'?: io.flow.billing.accounting.v0.models.FulfillmentCarrier;
12
13
  readonly 'owner': io.flow.billing.internal.v0.enums.ResponsibleParty;
13
14
  readonly 'origin'?: io.flow.billing.accounting.v0.models.FulfillmentOrigin;
14
15
  readonly 'business'?: io.flow.billing.accounting.v0.models.FulfillmentBusiness;
@@ -19,6 +20,12 @@ declare namespace io.flow.billing.accounting.v0.models {
19
20
  readonly 'vat_registration_number': string;
20
21
  }
21
22
 
23
+ interface FulfillmentCarrier {
24
+ readonly 'id': string;
25
+ readonly 'service_id'?: string;
26
+ readonly 'tracking_number'?: string;
27
+ }
28
+
22
29
  interface FulfillmentOrigin {
23
30
  readonly 'country': string;
24
31
  readonly 'province_code'?: string;
@@ -182,6 +182,10 @@ declare namespace io.flow.billing.csv.v0.models {
182
182
  readonly 'source'?: io.flow.label.v0.enums.CostEstimateSource;
183
183
  }
184
184
 
185
+ interface BillingCsvMerchantReference {
186
+ readonly 'id': string;
187
+ }
188
+
185
189
  interface BillingCsvOrder {
186
190
  readonly 'number': string;
187
191
  readonly 'primary_identifier'?: string;
@@ -328,6 +332,7 @@ declare namespace io.flow.billing.csv.v0.models {
328
332
 
329
333
  interface BillingCsvTransactionAccount {
330
334
  readonly 'id': string;
335
+ readonly 'merchant'?: io.flow.billing.csv.v0.models.BillingCsvMerchantReference;
331
336
  readonly 'environment': io.flow.common.v0.enums.Environment;
332
337
  readonly 'source': io.flow.billing.csv.v0.models.BillingCsvTransactionAccountSourceSummary;
333
338
  }
@@ -364,6 +369,7 @@ declare namespace io.flow.billing.csv.v0.models {
364
369
  readonly 'trueup'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataTrueup;
365
370
  readonly 'carrier_charge'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataCarrierCharge;
366
371
  readonly 'manual'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataManual;
372
+ readonly 'failed_payout'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataFailedPayout;
367
373
  }
368
374
 
369
375
  interface BillingCsvTransactionMetadataCarrierCharge {
@@ -380,8 +386,14 @@ declare namespace io.flow.billing.csv.v0.models {
380
386
  readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
381
387
  }
382
388
 
389
+ interface BillingCsvTransactionMetadataFailedPayout {
390
+ readonly 'failed_payment': io.flow.billing.v0.models.TransactionMetadataFailedPayoutReference;
391
+ }
392
+
383
393
  interface BillingCsvTransactionMetadataManual {
394
+ readonly 'description': string;
384
395
  readonly 'original'?: io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
396
+ readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
385
397
  readonly 'url'?: string;
386
398
  }
387
399
 
@@ -7,7 +7,7 @@ declare namespace io.flow.billing.internal.v0.enums {
7
7
  type BankPaymentStatusCode = 'scheduled' | 'sent' | 'failed';
8
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
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' | 'pending_proof' | 'posted';
10
+ type BillingTransactionStatus = 'pending_proof' | 'posted';
11
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
12
  type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
13
13
  type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
@@ -16,8 +16,7 @@ declare namespace io.flow.billing.internal.v0.enums {
16
16
  type DutyTransactionType = 'adjustment' | 'reversal' | 'duty';
17
17
  type FeesSource = 'settings' | 'authorization_bundle';
18
18
  type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
19
- type MainTransactionStatus = 'scheduled' | 'pending_proof';
20
- type ManualTransactionCategory = 'cancelled_order_refund' | 'channel_partner_initiated' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'partial_refund' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee' | 'bank_payment_failure';
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';
21
20
  type OrderCancellationInitiatedBy = 'flow' | 'organization';
22
21
  type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
23
22
  type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
@@ -123,6 +122,7 @@ declare namespace io.flow.billing.internal.v0.models {
123
122
  readonly 'liabilities_method': io.flow.billing.internal.v0.enums.AccountSettingLiabilitiesMethod;
124
123
  readonly 'enable_fee_reversals': boolean;
125
124
  readonly 'record_reason_for_transactions_pending_payout': boolean;
125
+ readonly 'enable_negative_debits': boolean;
126
126
  }
127
127
 
128
128
  interface AccountSource {
@@ -203,6 +203,16 @@ declare namespace io.flow.billing.internal.v0.models {
203
203
  readonly 'attributes'?: Record<string, string>;
204
204
  }
205
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
+
206
216
  interface BankPaymentStatusForm {
207
217
  readonly 'code': io.flow.billing.internal.v0.enums.BankPaymentStatusCode;
208
218
  readonly 'failure_reason'?: io.flow.billing.v0.enums.PayoutStatusFailureCode;
@@ -480,6 +490,17 @@ declare namespace io.flow.billing.internal.v0.models {
480
490
  readonly 'timestamp': string;
481
491
  }
482
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
+
483
504
  interface Components {
484
505
  readonly 'vat': io.flow.common.v0.models.Price;
485
506
  readonly 'duty': io.flow.common.v0.models.Price;
@@ -530,7 +551,14 @@ declare namespace io.flow.billing.internal.v0.models {
530
551
  readonly 'reason': string;
531
552
  }
532
553
 
533
- interface ExplicitStatementForm {
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';
534
562
  readonly 'account_id': string;
535
563
  readonly 'reason': string;
536
564
  readonly 'transaction_ids': string[];
@@ -701,6 +729,11 @@ declare namespace io.flow.billing.internal.v0.models {
701
729
  readonly 'created_at': string;
702
730
  }
703
731
 
732
+ interface LostChargeback {
733
+ readonly 'id': string;
734
+ readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
735
+ }
736
+
704
737
  interface MainTransaction {
705
738
  readonly 'id': string;
706
739
  readonly 'account': io.flow.billing.v0.models.AccountReference;
@@ -734,7 +767,6 @@ declare namespace io.flow.billing.internal.v0.models {
734
767
  readonly 'currency'?: string;
735
768
  readonly 'description': string;
736
769
  readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
737
- readonly 'posted_at'?: string;
738
770
  readonly 'order'?: io.flow.billing.internal.v0.models.ManualTransactionFormOrder;
739
771
  readonly 'original_transaction_id'?: string;
740
772
  readonly 'attributes'?: Record<string, string>;
@@ -933,6 +965,12 @@ declare namespace io.flow.billing.internal.v0.models {
933
965
  readonly 'shipping_notification_id': string;
934
966
  }
935
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
+
936
974
  interface SimpleAccountReference {
937
975
  readonly 'id': string;
938
976
  }
@@ -1091,9 +1129,10 @@ declare namespace io.flow.billing.internal.v0.unions {
1091
1129
  type AdjustmentAmount = (io.flow.billing.internal.v0.models.AdjustmentAmountPercentage | io.flow.billing.internal.v0.models.AdjustmentAmountFixed);
1092
1130
  type AdjustmentDetails = (io.flow.billing.internal.v0.models.AdjustmentAmountPercentage | io.flow.billing.internal.v0.models.AdjustmentAmountFixed | io.flow.billing.internal.v0.models.AdjustmentDetailsProcessingTransaction);
1093
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);
1094
1133
  type OrderCancellationEvidence = (io.flow.billing.internal.v0.models.OrderCancellationEvidenceManual | io.flow.billing.internal.v0.models.OrderCancellationEvidenceFullyRefundedNotFulfilled | io.flow.billing.internal.v0.models.OrderCancellationEvidenceReturnToSender);
1095
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);
1096
- 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);
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);
1097
1136
  type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
1098
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);
1099
1138
  }
@@ -1,6 +1,7 @@
1
1
  declare namespace io.flow.billing.reporting.v0.enums {
2
+ type ReportPaymentType = 'credit' | 'debit';
2
3
  type ReportStatus = 'created' | 'completed' | 'completed_no_records' | 'failed';
3
- type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment';
4
+ type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment' | 'account_quarterly_balances' | 'invariants';
4
5
  type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
5
6
  type RevenueRecordType = 'pending' | 'sales' | 'refund';
6
7
  }
@@ -36,8 +37,9 @@ declare namespace io.flow.billing.reporting.v0.models {
36
37
  readonly 'id': string;
37
38
  readonly 'status': io.flow.billing.reporting.v0.enums.ReportStatus;
38
39
  readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
39
- readonly 'from': string;
40
- readonly 'to': string;
40
+ readonly 'from'?: string;
41
+ readonly 'to'?: string;
42
+ readonly 'payment_type'?: io.flow.billing.reporting.v0.enums.ReportPaymentType;
41
43
  readonly 'url'?: string;
42
44
  readonly 'processed_at'?: string;
43
45
  }
@@ -60,9 +62,20 @@ declare namespace io.flow.billing.reporting.v0.models {
60
62
  }
61
63
 
62
64
  interface ReportForm {
63
- readonly 'from': string;
64
- readonly 'to': string;
65
65
  readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
66
+ readonly 'from'?: string;
67
+ readonly 'to'?: string;
68
+ readonly 'payment_type'?: io.flow.billing.reporting.v0.enums.ReportPaymentType;
69
+ readonly 'orders'?: io.flow.billing.reporting.v0.models.ReportOrderReference[];
70
+ }
71
+
72
+ interface ReportMerchant {
73
+ readonly 'id': string;
74
+ }
75
+
76
+ interface ReportOrderReference {
77
+ readonly 'organization_id': string;
78
+ readonly 'order_number': string;
66
79
  }
67
80
 
68
81
  interface ReportOwner {
@@ -193,7 +206,6 @@ declare namespace io.flow.billing.reporting.v0.models {
193
206
  readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
194
207
  readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
195
208
  readonly 'freight': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
196
- readonly 'refund': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
197
209
  }
198
210
 
199
211
  interface ReportingMonetaryValue {
@@ -304,6 +316,7 @@ declare namespace io.flow.billing.reporting.v0.models {
304
316
  readonly 'payment': io.flow.billing.reporting.v0.models.ReportPayment;
305
317
  readonly 'bank_account': io.flow.billing.reporting.v0.models.ReportBankAccountCleartext;
306
318
  readonly 'account': io.flow.billing.reporting.v0.models.ReportAccount;
319
+ readonly 'merchant': io.flow.billing.reporting.v0.models.ReportMerchant;
307
320
  readonly 'owner': io.flow.billing.reporting.v0.models.ReportOwner;
308
321
  readonly 'description': string;
309
322
  }
@@ -4,8 +4,8 @@ declare namespace io.flow.billing.v0.enums {
4
4
  type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
5
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';
6
6
  type StatementAttachmentType = 'csv';
7
- type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
8
- type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
7
+ type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'trueup_base' | 'trueup_surcharge' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund' | 'failed_payout';
8
+ type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
9
9
  type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
10
10
  }
11
11
 
@@ -294,17 +294,14 @@ declare namespace io.flow.billing.v0.models {
294
294
  readonly 'carrier_id': string;
295
295
  readonly 'carrier_tracking_number': string;
296
296
  readonly 'revenue_share_percentage': number;
297
- readonly 'outbound'?: io.flow.billing.v0.models.TransactionMetadataCarrierChargeOutbound;
298
- }
299
-
300
- interface TransactionMetadataCarrierChargeOutbound {
301
- readonly 'transaction_id': string;
297
+ readonly 'outbound'?: io.flow.billing.v0.models.TransactionMetadataOutboundTransaction;
302
298
  }
303
299
 
304
300
  interface TransactionMetadataChannel {
305
301
  readonly 'discriminator': 'channel';
306
302
  readonly 'method': string;
307
303
  readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
304
+ readonly 'organization_transaction': io.flow.billing.v0.models.TransactionReference;
308
305
  }
309
306
 
310
307
  interface TransactionMetadataChannelCardMetadata {
@@ -317,6 +314,15 @@ declare namespace io.flow.billing.v0.models {
317
314
  readonly 'country': string;
318
315
  }
319
316
 
317
+ interface TransactionMetadataFailedPayout {
318
+ readonly 'discriminator': 'failed_payout';
319
+ readonly 'failed_payout': io.flow.billing.v0.models.TransactionMetadataFailedPayoutReference;
320
+ }
321
+
322
+ interface TransactionMetadataFailedPayoutReference {
323
+ readonly 'id': string;
324
+ }
325
+
320
326
  interface TransactionMetadataManual {
321
327
  readonly 'discriminator': 'manual';
322
328
  readonly 'description': string;
@@ -328,6 +334,16 @@ declare namespace io.flow.billing.v0.models {
328
334
  readonly 'id': string;
329
335
  }
330
336
 
337
+ interface TransactionMetadataOutboundTransaction {
338
+ readonly 'transaction_id': string;
339
+ }
340
+
341
+ interface TransactionMetadataPaymentTransaction {
342
+ readonly 'discriminator': 'payment_transaction';
343
+ readonly 'id'?: string;
344
+ readonly 'key'?: string;
345
+ }
346
+
331
347
  interface TransactionMetadataShippingLabel {
332
348
  readonly 'discriminator': 'shipping_label';
333
349
  readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
@@ -347,6 +363,22 @@ declare namespace io.flow.billing.v0.models {
347
363
  readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupData;
348
364
  }
349
365
 
366
+ interface TransactionMetadataTrueupBase {
367
+ readonly 'discriminator': 'trueup_base';
368
+ readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
369
+ readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupBaseData;
370
+ readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupBaseData;
371
+ }
372
+
373
+ interface TransactionMetadataTrueupBaseData {
374
+ readonly 'source': io.flow.billing.v0.enums.TrueupSource;
375
+ readonly 'weights': io.flow.billing.v0.models.TrueupLabelWeights;
376
+ readonly 'units': io.flow.billing.v0.models.TrueupLabelUnits;
377
+ readonly 'base': io.flow.billing.v0.models.TrueupLabelBaseV2;
378
+ readonly 'fuel'?: io.flow.billing.v0.models.TrueupLabelFuel;
379
+ readonly 'total': number;
380
+ }
381
+
350
382
  interface TransactionMetadataTrueupData {
351
383
  readonly 'source': io.flow.billing.v0.enums.TrueupSource;
352
384
  readonly 'units': io.flow.billing.v0.models.TrueupLabelUnits;
@@ -357,6 +389,18 @@ declare namespace io.flow.billing.v0.models {
357
389
  readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
358
390
  }
359
391
 
392
+ interface TransactionMetadataTrueupSurcharge {
393
+ readonly 'discriminator': 'trueup_surcharge';
394
+ readonly 'original': io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
395
+ readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataTrueupSurchargeData;
396
+ readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupSurchargeData;
397
+ }
398
+
399
+ interface TransactionMetadataTrueupSurchargeData {
400
+ readonly 'source': io.flow.billing.v0.enums.TrueupSource;
401
+ readonly 'surcharge': io.flow.billing.v0.models.TrueupLabelSurcharge;
402
+ }
403
+
360
404
  interface TransactionReference {
361
405
  readonly 'id': string;
362
406
  }
@@ -366,6 +410,20 @@ declare namespace io.flow.billing.v0.models {
366
410
  readonly 'weight': number;
367
411
  }
368
412
 
413
+ interface TrueupLabelBaseV2 {
414
+ readonly 'amount': number;
415
+ }
416
+
417
+ interface TrueupLabelBaseWeight {
418
+ readonly 'weight': number;
419
+ }
420
+
421
+ interface TrueupLabelFuel {
422
+ readonly 'amount': number;
423
+ readonly 'percentage'?: number;
424
+ readonly 'per_weight_unit'?: number;
425
+ }
426
+
369
427
  interface TrueupLabelSurcharge {
370
428
  readonly 'amount': number;
371
429
  readonly 'type': io.flow.trueup.v0.enums.TrueupSurchargeType;
@@ -378,6 +436,12 @@ declare namespace io.flow.billing.v0.models {
378
436
  readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
379
437
  }
380
438
 
439
+ interface TrueupLabelWeights {
440
+ readonly 'base': io.flow.billing.v0.models.TrueupLabelBaseWeight;
441
+ readonly 'dead'?: io.flow.trueup.v0.models.DeadWeight;
442
+ readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
443
+ }
444
+
381
445
  interface WithholdingDeduction {
382
446
  readonly 'type': io.flow.billing.v0.enums.WithholdingDeductionType;
383
447
  readonly 'amount': number;
@@ -389,5 +453,5 @@ declare namespace io.flow.billing.v0.unions {
389
453
  type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
390
454
  type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
391
455
  type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
392
- 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.TransactionMetadataCarrierCharge | io.flow.billing.v0.models.TransactionMetadataManual);
456
+ 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.TransactionMetadataTrueupBase | io.flow.billing.v0.models.TransactionMetadataTrueupSurcharge | io.flow.billing.v0.models.TransactionMetadataCarrierCharge | io.flow.billing.v0.models.TransactionMetadataManual | io.flow.billing.v0.models.TransactionMetadataFailedPayout | io.flow.billing.v0.models.TransactionMetadataPaymentTransaction);
393
457
  }