@flowio/api-types 0.0.211 → 0.0.213

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.
@@ -359,9 +359,16 @@ declare namespace io.flow.billing.csv.v0.models {
359
359
  readonly 'shipping_label'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabel;
360
360
  readonly 'shipping_label_revenue_share'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataShippingLabelRevenueShare;
361
361
  readonly 'trueup'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataTrueup;
362
+ readonly 'carrier_charge'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataCarrierCharge;
362
363
  readonly 'manual'?: io.flow.billing.csv.v0.models.BillingCsvTransactionMetadataManual;
363
364
  }
364
365
 
366
+ interface BillingCsvTransactionMetadataCarrierCharge {
367
+ readonly 'reason': io.flow.trueup.v0.enums.CarrierChargeReason;
368
+ readonly 'carrier_id': string;
369
+ readonly 'carrier_tracking_number': string;
370
+ }
371
+
365
372
  interface BillingCsvTransactionMetadataChannel {
366
373
  readonly 'method': string;
367
374
  readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
@@ -4,10 +4,11 @@ declare namespace io.flow.billing.internal.v0.enums {
4
4
  type AdjustmentTransactionType = 'adjustment' | 'reversal';
5
5
  type BankPaymentStatusCode = 'scheduled' | 'sent' | 'failed';
6
6
  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';
7
- type BillingStatementAttachmentKey = 'invoice' | 'statement' | 'consumer_invoice' | 'credit_memo' | 'channel_billed' | 'transactions' | 'virtual_card' | 'tax_remittance' | 'manual' | 'orders' | 'label' | 'order_service' | 'tax' | 'duty' | 'trueup' | 'all';
7
+ 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';
8
8
  type BillingStatementBatchFileKey = 'summary';
9
9
  type BillingTransactionStatus = 'pending' | 'pending_proof' | 'posted';
10
- 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';
10
+ 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';
11
+ type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge';
11
12
  type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
12
13
  type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
13
14
  type DisputeTransactionType = 'adjustment' | 'dispute';
@@ -15,12 +16,11 @@ declare namespace io.flow.billing.internal.v0.enums {
15
16
  type FeesSource = 'settings' | 'authorization_bundle';
16
17
  type LabelTransactionType = 'adjustment' | 'reversal' | 'billable_label' | 'fee' | 'revenue_share';
17
18
  type MainTransactionStatus = 'scheduled' | 'pending_proof';
18
- 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';
19
+ 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
20
  type OrderCancellationInitiatedBy = 'flow' | 'organization';
20
21
  type OrderTransactionType = 'adjustment' | 'reversal' | 'order_service';
21
22
  type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
22
23
  type ProcessingTransactionType = 'adjustment' | 'reversal' | 'capture' | 'refund' | 'fully_subsidized_order' | 'credit_payment';
23
- type QueuedRecordType = 'capture' | 'channel_transaction' | 'consumer_invoice' | 'fulfillment_in_transit' | 'fulfillment_shipping_notification' | 'fulfillment_external' | 'fulfillment_order_combined_shipment' | 'fulfillment_order_time' | 'label_tracking_summary' | 'label_invoice_request' | 'carrier_charge' | 'carrier_charge_file' | 'order' | 'order_identifier' | 'organization_onboarding_state' | 'posting_proof' | 'refund' | 'refund_over_capture' | 'sales_record' | 'statement_batch' | 'statement_email' | 'statement_summary_email' | 'pending_payout_transaction_event' | 'credit_and_subsidy' | 'negative_balance_guarantee';
24
24
  type ResponsibleParty = 'flow' | 'organization';
25
25
  type StatementTransferTransactionLocation = 'transactions_file' | 'summary';
26
26
  type SubscriptionFrequency = 'yearly' | 'monthly';
@@ -315,6 +315,7 @@ declare namespace io.flow.billing.internal.v0.models {
315
315
  readonly 'tax': io.flow.common.v0.models.Price;
316
316
  readonly 'duty': io.flow.common.v0.models.Price;
317
317
  readonly 'trueup': io.flow.common.v0.models.Price;
318
+ readonly 'carrier_charge': io.flow.common.v0.models.Price;
318
319
  readonly 'ending_balance': io.flow.common.v0.models.Price;
319
320
  }
320
321
 
@@ -329,6 +330,19 @@ declare namespace io.flow.billing.internal.v0.models {
329
330
  readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
330
331
  }
331
332
 
333
+ interface CarrierChargeTransaction {
334
+ readonly 'discriminator': 'carrier_charge_transaction';
335
+ readonly 'order': io.flow.billing.internal.v0.models.BillingOrderTransactionOrderReference;
336
+ readonly 'id': string;
337
+ readonly 'type': io.flow.billing.internal.v0.enums.BillingTransactionType;
338
+ readonly 'status': io.flow.billing.internal.v0.enums.BillingTransactionStatus;
339
+ readonly 'posted_at'?: string;
340
+ readonly 'value': io.flow.common.v0.models.Price;
341
+ readonly 'description': string;
342
+ readonly 'statement'?: io.flow.billing.internal.v0.models.BillingStatementReference;
343
+ readonly 'created_at': string;
344
+ }
345
+
332
346
  interface ChannelAccount {
333
347
  readonly 'channel': io.flow.common.v0.models.ChannelReference;
334
348
  readonly 'id': string;
@@ -1035,5 +1049,5 @@ declare namespace io.flow.billing.internal.v0.unions {
1035
1049
  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);
1036
1050
  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);
1037
1051
  type SpotRateMetadata = (io.flow.billing.internal.v0.models.SpotRateMetadataIdentity | io.flow.billing.internal.v0.models.SpotRateMetadataRate);
1038
- 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);
1052
+ 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);
1039
1053
  }
@@ -1,259 +1,36 @@
1
- declare namespace io.flow.billing.reporting.csv.v0.enums {
2
- type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
3
- }
4
-
5
1
  declare namespace io.flow.billing.reporting.csv.v0.models {
6
- interface FulfillmentShopperBreakdown {
7
- readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
8
- readonly 'fees': io.flow.billing.reporting.csv.v0.models.ReportingShopperFees;
9
- readonly 'product': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
10
- readonly 'subtotal': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
11
- readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
12
- readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
13
- readonly 'discount': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
14
- readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
15
- }
16
-
17
- interface MarkedAsFinal {
18
- readonly 'products': boolean;
19
- readonly 'shipping': boolean;
20
- }
21
-
22
- interface RecordReference {
23
- readonly 'id': string;
24
- }
25
-
26
- interface RefundRecord {
27
- readonly 'id': string;
28
- readonly 'parent'?: io.flow.billing.reporting.csv.v0.models.RecordReference;
29
- readonly 'merchant': io.flow.billing.reporting.csv.v0.models.ReportingOrganizationSummary;
30
- readonly 'order': io.flow.billing.reporting.csv.v0.models.ReportingOrderSummary;
31
- readonly 'entity': io.flow.billing.reporting.csv.v0.models.ReportingEntity;
32
- readonly 'vendor': io.flow.billing.reporting.csv.v0.models.ReportingVendor;
33
- readonly 'currencies': io.flow.billing.reporting.csv.v0.models.ReportingCurrencies;
34
- readonly 'conversion_rate': io.flow.billing.reporting.csv.v0.models.ReportingConversionRates;
35
- readonly 'reconciliation': io.flow.billing.reporting.csv.v0.models.ReportingReconciliation;
36
- readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
37
- readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
38
- readonly 'merchant_transactions': io.flow.billing.reporting.csv.v0.models.ReportingMerchantTransactions;
39
- readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
40
- readonly 'return'?: io.flow.billing.reporting.csv.v0.models.ReportingReturn;
41
- }
42
-
43
- interface ReportingAuthorizationReference {
44
- readonly 'id': string;
45
- }
46
-
47
- interface ReportingBusiness {
48
- readonly 'vat_registration_number': string;
49
- readonly 'name'?: string;
50
- }
51
-
52
- interface ReportingConversionRates {
53
- readonly 'merchant': number;
54
- readonly 'entity': number;
55
- readonly 'usd': number;
56
- readonly 'eur': number;
57
- }
58
-
59
- interface ReportingCountry {
60
- readonly 'code': string;
61
- readonly 'is_eu': boolean;
62
- }
63
-
64
- interface ReportingCurrencies {
65
- readonly 'transaction': string;
66
- readonly 'merchant': string;
67
- readonly 'entity': string;
68
- }
69
-
70
- interface ReportingDebug {
71
- readonly 'console_order_link': string;
72
- readonly 'allocation_order_totals_delta'?: number;
73
- readonly 'allocation_order_item_discount_delta'?: number;
74
- readonly 'missing_item_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
75
- readonly 'missing_shipping_subsidies'?: io.flow.billing.reporting.csv.v0.models.ReportingDebugMissingSubsidies;
76
- }
77
-
78
- interface ReportingDebugMissingSubsidies {
79
- readonly 'price'?: boolean;
80
- readonly 'tax'?: boolean;
81
- readonly 'duty'?: boolean;
82
- }
83
-
84
- interface ReportingDestination {
85
- readonly 'country': io.flow.billing.reporting.csv.v0.models.ReportingCountry;
86
- readonly 'province'?: io.flow.billing.reporting.csv.v0.models.ReportingProvince;
87
- }
88
-
89
- interface ReportingEntity {
90
- readonly 'id': string;
91
- }
92
-
93
2
  interface ReportingFulfillment {
94
3
  readonly 'id': string;
95
4
  readonly 'sequence_number': number;
96
5
  readonly 'fulfilled_at': string;
97
6
  readonly 'completes_order': boolean;
98
- readonly 'payment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPayment;
99
- readonly 'value': io.flow.billing.reporting.csv.v0.models.FulfillmentShopperBreakdown;
100
- readonly 'dispatch_country'?: io.flow.billing.reporting.csv.v0.models.ReportingCountry;
101
- readonly 'destination': io.flow.billing.reporting.csv.v0.models.ReportingDestination;
7
+ readonly 'payment': io.flow.billing.reporting.v0.models.ReportingPayment;
8
+ readonly 'value': io.flow.billing.reporting.v0.models.FulfillmentShopperBreakdown;
9
+ readonly 'dispatch_country'?: io.flow.billing.reporting.v0.models.ReportingCountry;
10
+ readonly 'destination': io.flow.billing.reporting.v0.models.ReportingDestination;
102
11
  readonly 'carrier'?: string;
103
- readonly 'is': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentIs;
104
- readonly 'has': io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentHas;
105
- readonly 'fx': io.flow.billing.reporting.csv.v0.models.ReportingFx;
106
- readonly 'business'?: io.flow.billing.reporting.csv.v0.models.ReportingBusiness;
107
- }
108
-
109
- interface ReportingFulfillmentHas {
110
- readonly 'zero_vat_product': boolean;
111
- }
112
-
113
- interface ReportingFulfillmentIs {
114
- readonly 'replacement': boolean;
115
- readonly 'virtual': io.flow.billing.reporting.csv.v0.enums.ReportingFulfillmentIsVirtual;
116
- readonly 'duties_guaranteed': boolean;
117
- readonly 'wyol': boolean;
118
- readonly 'b2b': boolean;
119
- readonly 'domestic': boolean;
120
- }
121
-
122
- interface ReportingFulfillmentPayment {
123
- readonly 'metadata'?: io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPaymentMetadata;
124
- readonly 'psp': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
125
- readonly 'credit': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
126
- readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
127
- }
128
-
129
- interface ReportingFulfillmentPaymentMetadata {
130
- readonly 'gateway': io.flow.payment.internal.v0.enums.Processor;
131
- readonly 'method': string;
132
- readonly 'psp_reference'?: string;
133
- readonly 'authorization'?: io.flow.billing.reporting.csv.v0.models.ReportingAuthorizationReference;
134
- readonly 'settlement_date': string;
135
- readonly 'additional_authorizations'?: io.flow.billing.reporting.csv.v0.models.ReportingFulfillmentPaymentMetadataAdditionalAuthorizations;
136
- }
137
-
138
- interface ReportingFulfillmentPaymentMetadataAdditionalAuthorizations {
139
- readonly 'ids': string;
140
- }
141
-
142
- interface ReportingFx {
143
- readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
144
- readonly 'fees': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
145
- readonly 'product': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
146
- readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
147
- readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
148
- readonly 'total': io.flow.billing.reporting.csv.v0.models.ReportingUsd;
149
- }
150
-
151
- interface ReportingMerchantFees {
152
- readonly 'duty_guarantee': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
153
- readonly 'mor': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
154
- readonly 'fraud': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
155
- readonly 'fx': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
156
- readonly 'processing': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
157
- readonly 'rate_lock': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
158
- readonly 'transfer': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
159
- }
160
-
161
- interface ReportingMerchantSubsidies {
162
- readonly 'shipping': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
163
- readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
164
- readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
165
- readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
166
- }
167
-
168
- interface ReportingMerchantTransactions {
169
- readonly 'adjustment': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
170
- readonly 'reversal': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
171
- readonly 'tax': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
172
- readonly 'duty': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
173
- readonly 'freight': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
174
- readonly 'refund': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
175
- }
176
-
177
- interface ReportingMonetaryValue {
178
- readonly 'transaction': number;
179
- readonly 'merchant': number;
180
- readonly 'entity': number;
181
- readonly 'usd': number;
182
- readonly 'eur': number;
183
- }
184
-
185
- interface ReportingOrderSummary {
186
- readonly 'id': string;
187
- readonly 'number': string;
188
- readonly 'submitted_at': string;
189
- }
190
-
191
- interface ReportingOrganizationSummary {
192
- readonly 'id': string;
193
- readonly 'name': string;
194
- }
195
-
196
- interface ReportingProvince {
197
- readonly 'code'?: string;
198
- readonly 'name': string;
199
- }
200
-
201
- interface ReportingReconciliation {
202
- readonly 'date': string;
203
- readonly 'month': number;
204
- readonly 'year': number;
205
- }
206
-
207
- interface ReportingReturn {
208
- readonly 'placeholder': string;
209
- }
210
-
211
- interface ReportingShopperFees {
212
- readonly 'fuel': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
213
- readonly 'remote_area': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
214
- readonly 'oversize': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
215
- readonly 'ccf': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
216
- readonly 'emergency': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
217
- readonly 'peak': io.flow.billing.reporting.csv.v0.models.ReportingMonetaryValue;
218
- }
219
-
220
- interface ReportingUsd {
221
- readonly 'usd': number;
222
- }
223
-
224
- interface ReportingVatRemittance {
225
- readonly 'currency': string;
226
- readonly 'rate': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittanceRate;
227
- }
228
-
229
- interface ReportingVatRemittanceRate {
230
- readonly 'entity': number;
231
- }
232
-
233
- interface ReportingVendor {
234
- readonly 'id': string;
12
+ readonly 'is': io.flow.billing.reporting.v0.models.ReportingFulfillmentIs;
13
+ readonly 'has': io.flow.billing.reporting.v0.models.ReportingFulfillmentHas;
14
+ readonly 'fx': io.flow.billing.reporting.v0.models.ReportingFx;
15
+ readonly 'business'?: io.flow.billing.reporting.v0.models.ReportingBusiness;
235
16
  }
236
17
 
237
18
  interface SalesRecord {
238
19
  readonly 'id': string;
239
- readonly 'parent'?: io.flow.billing.reporting.csv.v0.models.RecordReference;
240
- readonly 'merchant': io.flow.billing.reporting.csv.v0.models.ReportingOrganizationSummary;
241
- readonly 'order': io.flow.billing.reporting.csv.v0.models.ReportingOrderSummary;
242
- readonly 'entity': io.flow.billing.reporting.csv.v0.models.ReportingEntity;
243
- readonly 'vendor': io.flow.billing.reporting.csv.v0.models.ReportingVendor;
244
- readonly 'currencies': io.flow.billing.reporting.csv.v0.models.ReportingCurrencies;
245
- readonly 'conversion_rate': io.flow.billing.reporting.csv.v0.models.ReportingConversionRates;
246
- readonly 'reconciliation': io.flow.billing.reporting.csv.v0.models.ReportingReconciliation;
247
- readonly 'merchant_subsidies': io.flow.billing.reporting.csv.v0.models.ReportingMerchantSubsidies;
248
- readonly 'merchant_fees': io.flow.billing.reporting.csv.v0.models.ReportingMerchantFees;
249
- readonly 'merchant_transactions': io.flow.billing.reporting.csv.v0.models.ReportingMerchantTransactions;
250
- readonly 'debug': io.flow.billing.reporting.csv.v0.models.ReportingDebug;
20
+ readonly 'parent'?: io.flow.billing.reporting.v0.models.RecordReference;
21
+ readonly 'merchant': io.flow.billing.reporting.v0.models.ReportingOrganizationSummary;
22
+ readonly 'order': io.flow.billing.reporting.v0.models.ReportingOrderSummary;
23
+ readonly 'entity': io.flow.billing.reporting.v0.models.ReportingEntity;
24
+ readonly 'vendor': io.flow.billing.reporting.v0.models.ReportingVendor;
25
+ readonly 'currencies': io.flow.billing.reporting.v0.models.ReportingCurrencies;
26
+ readonly 'conversion_rate': io.flow.billing.reporting.v0.models.ReportingConversionRates;
27
+ readonly 'reconciliation': io.flow.billing.reporting.v0.models.ReportingReconciliation;
28
+ readonly 'merchant_subsidies': io.flow.billing.reporting.v0.models.ReportingMerchantSubsidies;
29
+ readonly 'merchant_fees': io.flow.billing.reporting.v0.models.ReportingMerchantFees;
30
+ readonly 'merchant_transactions': io.flow.billing.reporting.v0.models.ReportingMerchantTransactions;
31
+ readonly 'debug': io.flow.billing.reporting.v0.models.ReportingDebug;
251
32
  readonly 'fulfillment': io.flow.billing.reporting.csv.v0.models.ReportingFulfillment;
252
- readonly 'vat_remittance': io.flow.billing.reporting.csv.v0.models.ReportingVatRemittance;
253
- readonly 'marked_as_final': io.flow.billing.reporting.csv.v0.models.MarkedAsFinal;
254
- }
255
-
256
- interface TransactionReference {
257
- readonly 'id': string;
33
+ readonly 'vat_remittance': io.flow.billing.reporting.v0.models.ReportingVatRemittance;
34
+ readonly 'marked_as_final': io.flow.billing.reporting.v0.models.MarkedAsFinal;
258
35
  }
259
36
  }
@@ -0,0 +1,289 @@
1
+ declare namespace io.flow.billing.reporting.v0.enums {
2
+ type ReportStatus = 'created' | 'completed' | 'completed_no_records' | 'failed';
3
+ type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account';
4
+ type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
5
+ type RevenueRecordType = 'sales' | 'refund';
6
+ }
7
+
8
+ declare namespace io.flow.billing.reporting.v0.models {
9
+ interface FulfillmentShopperBreakdown {
10
+ readonly 'shipping': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
11
+ readonly 'fees': io.flow.billing.reporting.v0.models.ReportingShopperFees;
12
+ readonly 'product': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
13
+ readonly 'subtotal': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
14
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
15
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
16
+ readonly 'discount': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
17
+ readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
18
+ }
19
+
20
+ interface MarkedAsFinal {
21
+ readonly 'products': boolean;
22
+ readonly 'shipping': boolean;
23
+ }
24
+
25
+ interface NonChannelPaymentBankAccount {
26
+ readonly 'payment': io.flow.billing.reporting.v0.models.ReportPayment;
27
+ readonly 'bank_account': io.flow.billing.reporting.v0.models.ReportBankAccount;
28
+ readonly 'account': io.flow.billing.reporting.v0.models.ReportAccount;
29
+ }
30
+
31
+ interface RecordReference {
32
+ readonly 'id': string;
33
+ }
34
+
35
+ interface Report {
36
+ readonly 'id': string;
37
+ readonly 'status': io.flow.billing.reporting.v0.enums.ReportStatus;
38
+ readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
39
+ readonly 'from': string;
40
+ readonly 'to': string;
41
+ readonly 'url'?: string;
42
+ readonly 'processed_at'?: string;
43
+ }
44
+
45
+ interface ReportAccount {
46
+ readonly 'id': string;
47
+ readonly 'source': io.flow.billing.internal.v0.models.AccountSource;
48
+ }
49
+
50
+ interface ReportBankAccount {
51
+ readonly 'id'?: string;
52
+ readonly 'last4'?: string;
53
+ }
54
+
55
+ interface ReportForm {
56
+ readonly 'from': string;
57
+ readonly 'to': string;
58
+ readonly 'type': io.flow.billing.reporting.v0.enums.ReportType;
59
+ }
60
+
61
+ interface ReportPayment {
62
+ readonly 'id': string;
63
+ readonly 'created_at': string;
64
+ }
65
+
66
+ interface ReportingAuthorizationReference {
67
+ readonly 'id': string;
68
+ }
69
+
70
+ interface ReportingBusiness {
71
+ readonly 'vat_registration_number': string;
72
+ readonly 'name'?: string;
73
+ }
74
+
75
+ interface ReportingConversionRates {
76
+ readonly 'merchant': number;
77
+ readonly 'entity': number;
78
+ readonly 'usd': number;
79
+ readonly 'eur': number;
80
+ }
81
+
82
+ interface ReportingCountry {
83
+ readonly 'code': string;
84
+ readonly 'is_eu': boolean;
85
+ }
86
+
87
+ interface ReportingCurrencies {
88
+ readonly 'transaction': string;
89
+ readonly 'merchant': string;
90
+ readonly 'entity': string;
91
+ }
92
+
93
+ interface ReportingDebug {
94
+ readonly 'console_order_link': string;
95
+ readonly 'allocation_order_totals_delta'?: number;
96
+ readonly 'allocation_order_item_discount_delta'?: number;
97
+ readonly 'missing_item_subsidies'?: io.flow.billing.reporting.v0.models.ReportingDebugMissingSubsidies;
98
+ readonly 'missing_shipping_subsidies'?: io.flow.billing.reporting.v0.models.ReportingDebugMissingSubsidies;
99
+ }
100
+
101
+ interface ReportingDebugMissingSubsidies {
102
+ readonly 'price'?: boolean;
103
+ readonly 'tax'?: boolean;
104
+ readonly 'duty'?: boolean;
105
+ }
106
+
107
+ interface ReportingDestination {
108
+ readonly 'country': io.flow.billing.reporting.v0.models.ReportingCountry;
109
+ readonly 'province'?: io.flow.billing.reporting.v0.models.ReportingProvince;
110
+ }
111
+
112
+ interface ReportingEntity {
113
+ readonly 'id': string;
114
+ }
115
+
116
+ interface ReportingFulfillment {
117
+ readonly 'id': string;
118
+ readonly 'sequence_number': number;
119
+ readonly 'fulfilled_at': string;
120
+ readonly 'completes_order': boolean;
121
+ readonly 'payment': io.flow.billing.reporting.v0.models.ReportingPayment;
122
+ readonly 'refund'?: io.flow.billing.reporting.v0.models.ReportingRefundReference;
123
+ readonly 'value': io.flow.billing.reporting.v0.models.FulfillmentShopperBreakdown;
124
+ readonly 'dispatch_country'?: io.flow.billing.reporting.v0.models.ReportingCountry;
125
+ readonly 'destination'?: io.flow.billing.reporting.v0.models.ReportingDestination;
126
+ readonly 'shipment'?: io.flow.billing.reporting.v0.models.ReportingShipment;
127
+ readonly 'is': io.flow.billing.reporting.v0.models.ReportingFulfillmentIs;
128
+ readonly 'has': io.flow.billing.reporting.v0.models.ReportingFulfillmentHas;
129
+ readonly 'fx': io.flow.billing.reporting.v0.models.ReportingFx;
130
+ readonly 'business'?: io.flow.billing.reporting.v0.models.ReportingBusiness;
131
+ }
132
+
133
+ interface ReportingFulfillmentHas {
134
+ readonly 'zero_vat_product': boolean;
135
+ }
136
+
137
+ interface ReportingFulfillmentIs {
138
+ readonly 'replacement': boolean;
139
+ readonly 'virtual': io.flow.billing.reporting.v0.enums.ReportingFulfillmentIsVirtual;
140
+ readonly 'duties_guaranteed': boolean;
141
+ readonly 'wyol': boolean;
142
+ readonly 'b2b': boolean;
143
+ readonly 'domestic': boolean;
144
+ }
145
+
146
+ interface ReportingFx {
147
+ readonly 'shipping': io.flow.billing.reporting.v0.models.ReportingUsd;
148
+ readonly 'fees': io.flow.billing.reporting.v0.models.ReportingUsd;
149
+ readonly 'product': io.flow.billing.reporting.v0.models.ReportingUsd;
150
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingUsd;
151
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingUsd;
152
+ readonly 'total': io.flow.billing.reporting.v0.models.ReportingUsd;
153
+ }
154
+
155
+ interface ReportingMerchantBreakdown {
156
+ readonly 'subsidies': io.flow.billing.reporting.v0.models.ReportingMerchantSubsidies;
157
+ readonly 'fees': io.flow.billing.reporting.v0.models.ReportingMerchantFees;
158
+ readonly 'transactions': io.flow.billing.reporting.v0.models.ReportingMerchantTransactions;
159
+ }
160
+
161
+ interface ReportingMerchantFees {
162
+ readonly 'duty_guarantee': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
163
+ readonly 'mor': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
164
+ readonly 'fraud': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
165
+ readonly 'fx': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
166
+ readonly 'processing': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
167
+ readonly 'rate_lock': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
168
+ readonly 'transfer': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
169
+ }
170
+
171
+ interface ReportingMerchantSubsidies {
172
+ readonly 'shipping': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
173
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
174
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
175
+ readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
176
+ }
177
+
178
+ interface ReportingMerchantTransactions {
179
+ readonly 'adjustment': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
180
+ readonly 'reversal': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
181
+ readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
182
+ readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
183
+ readonly 'freight': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
184
+ readonly 'refund': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
185
+ }
186
+
187
+ interface ReportingMonetaryValue {
188
+ readonly 'transaction': number;
189
+ readonly 'merchant': number;
190
+ readonly 'entity': number;
191
+ readonly 'usd': number;
192
+ readonly 'eur': number;
193
+ }
194
+
195
+ interface ReportingOrderSummary {
196
+ readonly 'id': string;
197
+ readonly 'number': string;
198
+ readonly 'submitted_at': string;
199
+ }
200
+
201
+ interface ReportingOrganizationSummary {
202
+ readonly 'id': string;
203
+ readonly 'name': string;
204
+ }
205
+
206
+ interface ReportingPayment {
207
+ readonly 'metadata'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadata;
208
+ readonly 'psp': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
209
+ readonly 'credit': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
210
+ readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
211
+ }
212
+
213
+ interface ReportingPaymentMetadata {
214
+ readonly 'gateway': io.flow.payment.internal.v0.enums.Processor;
215
+ readonly 'method': string;
216
+ readonly 'psp_reference'?: string;
217
+ readonly 'authorization'?: io.flow.billing.reporting.v0.models.ReportingAuthorizationReference;
218
+ readonly 'settlement_date': string;
219
+ readonly 'additional_authorizations'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadataAdditionalAuthorizations;
220
+ }
221
+
222
+ interface ReportingPaymentMetadataAdditionalAuthorizations {
223
+ readonly 'ids': string;
224
+ }
225
+
226
+ interface ReportingProvince {
227
+ readonly 'code'?: string;
228
+ readonly 'name': string;
229
+ }
230
+
231
+ interface ReportingReconciliation {
232
+ readonly 'date': string;
233
+ readonly 'month': number;
234
+ readonly 'year': number;
235
+ }
236
+
237
+ interface ReportingRefundReference {
238
+ readonly 'id': string;
239
+ }
240
+
241
+ interface ReportingShipment {
242
+ readonly 'carrier': string;
243
+ readonly 'tracking_number'?: string;
244
+ }
245
+
246
+ interface ReportingShopperFees {
247
+ readonly 'fuel': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
248
+ readonly 'remote_area': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
249
+ readonly 'oversize': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
250
+ readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
251
+ readonly 'emergency': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
252
+ readonly 'peak': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
253
+ }
254
+
255
+ interface ReportingUsd {
256
+ readonly 'usd': number;
257
+ }
258
+
259
+ interface ReportingVatRemittance {
260
+ readonly 'currency': string;
261
+ readonly 'rate': io.flow.billing.reporting.v0.models.ReportingVatRemittanceRate;
262
+ }
263
+
264
+ interface ReportingVatRemittanceRate {
265
+ readonly 'entity': number;
266
+ }
267
+
268
+ interface ReportingVendor {
269
+ readonly 'id': string;
270
+ }
271
+
272
+ interface RevenueRecord {
273
+ readonly 'id': string;
274
+ readonly 'organization': io.flow.billing.reporting.v0.models.ReportingOrganizationSummary;
275
+ readonly 'parent'?: io.flow.billing.reporting.v0.models.RecordReference;
276
+ readonly 'type': io.flow.billing.reporting.v0.enums.RevenueRecordType;
277
+ readonly 'order': io.flow.billing.reporting.v0.models.ReportingOrderSummary;
278
+ readonly 'entity': io.flow.billing.reporting.v0.models.ReportingEntity;
279
+ readonly 'vendor': io.flow.billing.reporting.v0.models.ReportingVendor;
280
+ readonly 'currencies': io.flow.billing.reporting.v0.models.ReportingCurrencies;
281
+ readonly 'conversion_rate': io.flow.billing.reporting.v0.models.ReportingConversionRates;
282
+ readonly 'reconciliation': io.flow.billing.reporting.v0.models.ReportingReconciliation;
283
+ readonly 'merchant': io.flow.billing.reporting.v0.models.ReportingMerchantBreakdown;
284
+ readonly 'fulfillment': io.flow.billing.reporting.v0.models.ReportingFulfillment;
285
+ readonly 'vat_remittance': io.flow.billing.reporting.v0.models.ReportingVatRemittance;
286
+ readonly 'marked_as_final': io.flow.billing.reporting.v0.models.MarkedAsFinal;
287
+ readonly 'debug': io.flow.billing.reporting.v0.models.ReportingDebug;
288
+ }
289
+ }