@flowio/api-types 0.0.224 → 0.0.225

package/generated/io.flow.billing.csv.v0.billing-csv.d.ts

@@ -363,6 +363,7 @@ declare namespace io.flow.billing.csv.v0.models {
     readonly 'shipping_label_revenue_share'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabelRevenueShare;
     readonly 'trueup'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataTrueup;
     readonly 'carrier_charge'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataCarrierCharge;
+    readonly 'carrier_fee'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataCarrierFee;
     readonly 'manual'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataManual;
   }
 
@@ -375,6 +376,14 @@ declare namespace io.flow.billing.csv.v0.models {
     readonly 'outbound_transaction_id'?: string;
   }
 
+  interface BillingCsvTransactionMetadataCarrierFee {
+    readonly 'outbound_transaction_id': string;
+    readonly 'estimate_fixed_ddp'?: number;
+    readonly 'estimate_fixed_currency_conversion'?: number;
+    readonly 'actual_fixed_ddp'?: number;
+    readonly 'actual_fixed_currency_conversion'?: number;
+  }
+
   interface BillingCsvTransactionMetadataChannel {
     readonly 'method': string;
     readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;

package/generated/io.flow.billing.internal.v0.billing-internal.d.ts

@@ -6,17 +6,17 @@ declare namespace io.flow.billing.internal.v0.enums {
   type BankPaymentPromiseCompletedMethod = 'credit' | 'time';
   type BankPaymentStatusCode = 'scheduled' | 'sent' | 'failed';
   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';
-  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';
-  type BillingTransactionStatus = 'pending' | 'pending_proof' | 'posted';
-  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';
+  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';
+  type BillingTransactionStatus = 'pending_proof' | 'posted';
+  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';
   type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
+  type CarrierFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
   type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
   type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
   type DisputeTransactionType = 'adjustment' | 'dispute';
   type DutyTransactionType = 'adjustment' | 'reversal' | 'duty';
   type FeesSource = 'settings' | 'authorization_bundle';
   type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
-  type MainTransactionStatus = 'scheduled' | 'pending_proof';
   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';
   type OrderCancellationInitiatedBy = 'flow' | 'organization';
   type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
@@ -347,6 +347,7 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'duty': io.flow.common.v0.models.Price;
     readonly 'trueup': io.flow.common.v0.models.Price;
     readonly 'carrier_charge': io.flow.common.v0.models.Price;
+    readonly 'carrier_fee': io.flow.common.v0.models.Price;
     readonly 'ending_balance': io.flow.common.v0.models.Price;
   }
 
@@ -380,6 +381,23 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'created_at': string;
   }
 
+  interface CarrierFeeTransaction {
+    readonly 'discriminator': 'carrier_fee_transaction';
+    readonly 'label_reference': io.flow.billing.internal.v0.models.CarrierFeeTransactionLabelReference;
+    readonly 'id': string;
+    readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
+    readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
+    readonly 'posted_at'?: string;
+    readonly 'value': io.flow.common.v0.models.Price;
+    readonly 'description': string;
+    readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
+    readonly 'created_at': string;
+  }
+
+  interface CarrierFeeTransactionLabelReference {
+    readonly 'id': string;
+  }
+
   interface ChannelAccount {
     readonly 'channel': io.flow.common.v0.models.ChannelReference;
     readonly 'id': string;
@@ -530,7 +548,14 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'reason': string;
   }
 
-  interface ExplicitStatementForm {
+  interface ExplicitStatementFormAllPendingPostedTransactions {
+    readonly 'discriminator': 'all_pending_posted_transactions';
+    readonly 'account_id': string;
+    readonly 'reason': string;
+  }
+
+  interface ExplicitStatementFormTransactionIds {
+    readonly 'discriminator': 'transaction_ids';
     readonly 'account_id': string;
     readonly 'reason': string;
     readonly 'transaction_ids': string[];
@@ -701,6 +726,11 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'created_at': string;
   }
 
+  interface LostChargeback {
+    readonly 'id': string;
+    readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
+  }
+
   interface MainTransaction {
     readonly 'id': string;
     readonly 'account': io.flow.billing.v0.models.AccountReference;
@@ -734,7 +764,6 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'currency'?: string;
     readonly 'description': string;
     readonly 'category'?: io.flow.billing.internal.v0.enums.ManualTransactionCategory;
-    readonly 'posted_at'?: string;
     readonly 'order'?: io.flow.billing.internal.v0.models.ManualTransactionFormOrder;
     readonly 'original_transaction_id'?: string;
     readonly 'attributes'?: Record<string, string>;
@@ -933,6 +962,12 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'shipping_notification_id': string;
   }
 
+  interface ProofOfPostingTimeElapsed {
+    readonly 'discriminator': 'time_elapsed';
+    readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
+    readonly 'created_at': string;
+  }
+
   interface SimpleAccountReference {
     readonly 'id': string;
   }
@@ -1091,9 +1126,10 @@ declare namespace io.flow.billing.internal.v0.unions {
   type AdjustmentAmount = (io.flow.billing.internal.v0.models.AdjustmentAmountPercentage | io.flow.billing.internal.v0.models.AdjustmentAmountFixed);
   type AdjustmentDetails = (io.flow.billing.internal.v0.models.AdjustmentAmountPercentage | io.flow.billing.internal.v0.models.AdjustmentAmountFixed | io.flow.billing.internal.v0.models.AdjustmentDetailsProcessingTransaction);
   type ChannelRateMetadata = (io.flow.billing.internal.v0.models.ChannelRateMetadataIdentity | io.flow.billing.internal.v0.models.ChannelRateMetadataRate);
+  type ExplicitStatementForm = (io.flow.billing.internal.v0.models.ExplicitStatementFormTransactionIds | io.flow.billing.internal.v0.models.ExplicitStatementFormAllPendingPostedTransactions);
   type OrderCancellationEvidence = (io.flow.billing.internal.v0.models.OrderCancellationEvidenceManual | io.flow.billing.internal.v0.models.OrderCancellationEvidenceFullyRefundedNotFulfilled | io.flow.billing.internal.v0.models.OrderCancellationEvidenceReturnToSender);
   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);
-  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);
+  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);
   type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
-  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);
+  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);
 }

package/generated/io.flow.billing.reporting.v0.billing-reporting.d.ts

@@ -1,6 +1,6 @@
 declare namespace io.flow.billing.reporting.v0.enums {
   type ReportStatus = 'created' | 'completed' | 'completed_no_records' | 'failed';
-  type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment';
+  type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment' | 'account_quarterly_balances';
   type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
   type RevenueRecordType = 'pending' | 'sales' | 'refund';
 }

package/generated/io.flow.billing.v0.billing.d.ts

@@ -4,7 +4,7 @@ declare namespace io.flow.billing.v0.enums {
   type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
   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';
   type StatementAttachmentType = 'csv';
-  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';
+  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';
   type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
   type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
 }
@@ -294,11 +294,18 @@ declare namespace io.flow.billing.v0.models {
     readonly 'carrier_id': string;
     readonly 'carrier_tracking_number': string;
     readonly 'revenue_share_percentage': number;
-    readonly 'outbound'?: io.flow.billing.v0.models.TransactionMetadataCarrierChargeOutbound;
+    readonly 'outbound'?: io.flow.billing.v0.models.TransactionMetadataOutboundTransaction;
   }
 
-  interface TransactionMetadataCarrierChargeOutbound {
-    readonly 'transaction_id': string;
+  interface TransactionMetadataCarrierFee {
+    readonly 'discriminator': 'carrier_fee';
+    readonly 'outbound': io.flow.billing.v0.models.TransactionMetadataOutboundTransaction;
+    readonly 'estimate': io.flow.billing.v0.models.TransactionMetadataCarrierFeeData;
+    readonly 'actual': io.flow.billing.v0.models.TransactionMetadataCarrierFeeData;
+  }
+
+  interface TransactionMetadataCarrierFeeData {
+    readonly 'surcharges': io.flow.billing.v0.models.TrueupLabelSurcharge[];
   }
 
   interface TransactionMetadataChannel {
@@ -328,6 +335,15 @@ declare namespace io.flow.billing.v0.models {
     readonly 'id': string;
   }
 
+  interface TransactionMetadataOutboundTransaction {
+    readonly 'transaction_id': string;
+  }
+
+  interface TransactionMetadataPaymentTransaction {
+    readonly 'discriminator': 'payment_transaction';
+    readonly 'key'?: string;
+  }
+
   interface TransactionMetadataShippingLabel {
     readonly 'discriminator': 'shipping_label';
     readonly 'request_method'?: io.flow.label.v0.enums.LabelRequestMethod;
@@ -389,5 +405,5 @@ declare namespace io.flow.billing.v0.unions {
   type BankAccountForm = (io.flow.billing.v0.models.BankAccountFormInfo | io.flow.billing.v0.models.BankAccountFormSimple);
   type PayoutStatus = (io.flow.billing.v0.models.PayoutStatusScheduled | io.flow.billing.v0.models.PayoutStatusSent | io.flow.billing.v0.models.PayoutStatusFailed);
   type Settlement = (io.flow.billing.v0.models.SettlementNoPayout | io.flow.billing.v0.models.SettlementPayout);
-  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);
+  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);
 }