@flowio/api-types 0.0.225 → 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
  }
@@ -363,8 +368,8 @@ declare namespace io.flow.billing.csv.v0.models {
363
368
  readonly 'shipping_label_revenue_share'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabelRevenueShare;
364
369
  readonly 'trueup'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataTrueup;
365
370
  readonly 'carrier_charge'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataCarrierCharge;
366
- readonly 'carrier_fee'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataCarrierFee;
367
371
  readonly 'manual'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataManual;
372
+ readonly 'failed_payout'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataFailedPayout;
368
373
  }
369
374
 
370
375
  interface BillingCsvTransactionMetadataCarrierCharge {
@@ -376,21 +381,19 @@ declare namespace io.flow.billing.csv.v0.models {
376
381
  readonly 'outbound_transaction_id'?: string;
377
382
  }
378
383
 
379
- interface BillingCsvTransactionMetadataCarrierFee {
380
- readonly 'outbound_transaction_id': string;
381
- readonly 'estimate_fixed_ddp'?: number;
382
- readonly 'estimate_fixed_currency_conversion'?: number;
383
- readonly 'actual_fixed_ddp'?: number;
384
- readonly 'actual_fixed_currency_conversion'?: number;
385
- }
386
-
387
384
  interface BillingCsvTransactionMetadataChannel {
388
385
  readonly 'method': string;
389
386
  readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
390
387
  }
391
388
 
389
+ interface BillingCsvTransactionMetadataFailedPayout {
390
+ readonly 'failed_payment': io.flow.billing.v0.models.TransactionMetadataFailedPayoutReference;
391
+ }
392
+
392
393
  interface BillingCsvTransactionMetadataManual {
394
+ readonly 'description': string;
393
395
  readonly 'original'?: io.flow.billing.v0.models.TransactionMetadataOriginalTransaction;
396
+ readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
394
397
  readonly 'url'?: string;
395
398
  }
396
399
 
@@ -6,18 +6,17 @@ declare namespace io.flow.billing.internal.v0.enums {
6
6
  type BankPaymentPromiseCompletedMethod = 'credit' | 'time';
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
- 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' | 'carrier_fee' | 'all';
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
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' | 'carrier_fee';
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
- type CarrierFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
14
13
  type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
15
14
  type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
16
15
  type DisputeTransactionType = 'adjustment' | 'dispute';
17
16
  type DutyTransactionType = 'adjustment' | 'reversal' | 'duty';
18
17
  type FeesSource = 'settings' | 'authorization_bundle';
19
18
  type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
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;
@@ -347,7 +357,6 @@ declare namespace io.flow.billing.internal.v0.models {
347
357
  readonly 'duty': io.flow.common.v0.models.Price;
348
358
  readonly 'trueup': io.flow.common.v0.models.Price;
349
359
  readonly 'carrier_charge': io.flow.common.v0.models.Price;
350
- readonly 'carrier_fee': io.flow.common.v0.models.Price;
351
360
  readonly 'ending_balance': io.flow.common.v0.models.Price;
352
361
  }
353
362
 
@@ -381,23 +390,6 @@ declare namespace io.flow.billing.internal.v0.models {
381
390
  readonly 'created_at': string;
382
391
  }
383
392
 
384
- interface CarrierFeeTransaction {
385
- readonly 'discriminator': 'carrier_fee_transaction';
386
- readonly 'label_reference': io.flow.billing.internal.v0.models.CarrierFeeTransactionLabelReference;
387
- readonly 'id': string;
388
- readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
389
- readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
390
- readonly 'posted_at'?: string;
391
- readonly 'value': io.flow.common.v0.models.Price;
392
- readonly 'description': string;
393
- readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
394
- readonly 'created_at': string;
395
- }
396
-
397
- interface CarrierFeeTransactionLabelReference {
398
- readonly 'id': string;
399
- }
400
-
401
393
  interface ChannelAccount {
402
394
  readonly 'channel': io.flow.common.v0.models.ChannelReference;
403
395
  readonly 'id': string;
@@ -498,6 +490,17 @@ declare namespace io.flow.billing.internal.v0.models {
498
490
  readonly 'timestamp': string;
499
491
  }
500
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
+
501
504
  interface Components {
502
505
  readonly 'vat': io.flow.common.v0.models.Price;
503
506
  readonly 'duty': io.flow.common.v0.models.Price;
@@ -1131,5 +1134,5 @@ declare namespace io.flow.billing.internal.v0.unions {
1131
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);
1132
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);
1133
1136
  type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
1134
- 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 | io.flow.billing.internal.v0.models.CarrierFeeTransaction);
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);
1135
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' | 'account_quarterly_balances';
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' | 'carrier_fee' | '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
 
@@ -297,21 +297,11 @@ declare namespace io.flow.billing.v0.models {
297
297
  readonly 'outbound'?: io.flow.billing.v0.models.TransactionMetadataOutboundTransaction;
298
298
  }
299
299
 
300
- interface TransactionMetadataCarrierFee {
301
- readonly 'discriminator': 'carrier_fee';
302
- readonly 'outbound': io.flow.billing.v0.models.TransactionMetadataOutboundTransaction;
303
- readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataCarrierFeeData;
304
- readonly 'actual': io.flow.billing.v0.models.TransactionMetadataCarrierFeeData;
305
- }
306
-
307
- interface TransactionMetadataCarrierFeeData {
308
- readonly 'surcharges': io.flow.billing.v0.models.TrueupLabelSurcharge[];
309
- }
310
-
311
300
  interface TransactionMetadataChannel {
312
301
  readonly 'discriminator': 'channel';
313
302
  readonly 'method': string;
314
303
  readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
304
+ readonly 'organization_transaction': io.flow.billing.v0.models.TransactionReference;
315
305
  }
316
306
 
317
307
  interface TransactionMetadataChannelCardMetadata {
@@ -324,6 +314,15 @@ declare namespace io.flow.billing.v0.models {
324
314
  readonly 'country': string;
325
315
  }
326
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
+
327
326
  interface TransactionMetadataManual {
328
327
  readonly 'discriminator': 'manual';
329
328
  readonly 'description': string;
@@ -341,6 +340,7 @@ declare namespace io.flow.billing.v0.models {
341
340
 
342
341
  interface TransactionMetadataPaymentTransaction {
343
342
  readonly 'discriminator': 'payment_transaction';
343
+ readonly 'id'?: string;
344
344
  readonly 'key'?: string;
345
345
  }
346
346
 
@@ -363,6 +363,22 @@ declare namespace io.flow.billing.v0.models {
363
363
  readonly 'actual': io.flow.billing.v0.models.TransactionMetadataTrueupData;
364
364
  }
365
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
+
366
382
  interface TransactionMetadataTrueupData {
367
383
  readonly 'source': io.flow.billing.v0.enums.TrueupSource;
368
384
  readonly 'units': io.flow.billing.v0.models.TrueupLabelUnits;
@@ -373,6 +389,18 @@ declare namespace io.flow.billing.v0.models {
373
389
  readonly 'dimensional'?: io.flow.trueup.v0.models.DimensionalWeight;
374
390
  }
375
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
+
376
404
  interface TransactionReference {
377
405
  readonly 'id': string;
378
406
  }
@@ -382,6 +410,20 @@ declare namespace io.flow.billing.v0.models {
382
410
  readonly 'weight': number;
383
411
  }
384
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
+
385
427
  interface TrueupLabelSurcharge {
386
428
  readonly 'amount': number;
387
429
  readonly 'type': io.flow.trueup.v0.enums.TrueupSurchargeType;
@@ -394,6 +436,12 @@ declare namespace io.flow.billing.v0.models {
394
436
  readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
395
437
  }
396
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
+
397
445
  interface WithholdingDeduction {
398
446
  readonly 'type': io.flow.billing.v0.enums.WithholdingDeductionType;
399
447
  readonly 'amount': number;
@@ -405,5 +453,5 @@ declare namespace io.flow.billing.v0.unions {
405
453
  type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
406
454
  type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
407
455
  type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
408
- 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.TransactionMetadataCarrierFee | io.flow.billing.v0.models.TransactionMetadataManual | io.flow.billing.v0.models.TransactionMetadataPaymentTransaction);
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);
409
457
  }