chargebee 3.0.0 → 3.0.2
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.
- package/CHANGELOG.md +9 -0
- package/README.md +5 -5
- package/cjs/environment.js +1 -1
- package/esm/environment.js +1 -1
- package/package.json +1 -1
- package/types/core.d.ts +574 -0
- package/types/index.d.ts +167 -0
- package/types/resources/Address.d.ts +71 -0
- package/types/resources/AdvanceInvoiceSchedule.d.ts +29 -0
- package/types/resources/AttachedItem.d.ts +114 -0
- package/types/resources/Attribute.d.ts +9 -0
- package/types/resources/BusinessEntity.d.ts +64 -0
- package/types/resources/BusinessEntityTransfer.d.ts +15 -0
- package/types/resources/Card.d.ts +171 -0
- package/types/resources/Comment.d.ts +89 -0
- package/types/resources/Contact.d.ts +16 -0
- package/types/resources/ContractTerm.d.ts +19 -0
- package/types/resources/Coupon.d.ts +314 -0
- package/types/resources/CouponCode.d.ts +70 -0
- package/types/resources/CouponSet.d.ts +111 -0
- package/types/resources/CreditNote.d.ts +628 -0
- package/types/resources/CreditNoteEstimate.d.ts +143 -0
- package/types/resources/Currency.d.ts +91 -0
- package/types/resources/Customer.d.ts +962 -0
- package/types/resources/CustomerEntitlement.d.ts +36 -0
- package/types/resources/DifferentialPrice.d.ts +142 -0
- package/types/resources/Discount.d.ts +24 -0
- package/types/resources/Download.d.ts +10 -0
- package/types/resources/Entitlement.d.ts +66 -0
- package/types/resources/EntitlementOverride.d.ts +76 -0
- package/types/resources/Estimate.d.ts +1237 -0
- package/types/resources/Event.d.ts +81 -0
- package/types/resources/Export.d.ts +607 -0
- package/types/resources/Feature.d.ts +142 -0
- package/types/resources/GatewayErrorDetail.d.ts +20 -0
- package/types/resources/Gift.d.ts +296 -0
- package/types/resources/Hierarchy.d.ts +12 -0
- package/types/resources/HostedPage.d.ts +1112 -0
- package/types/resources/ImpactedItem.d.ts +20 -0
- package/types/resources/ImpactedItemPrice.d.ts +20 -0
- package/types/resources/ImpactedSubscription.d.ts +20 -0
- package/types/resources/InAppSubscription.d.ts +116 -0
- package/types/resources/Invoice.d.ts +1691 -0
- package/types/resources/InvoiceEstimate.d.ts +143 -0
- package/types/resources/Item.d.ts +204 -0
- package/types/resources/ItemEntitlement.d.ts +103 -0
- package/types/resources/ItemFamily.d.ts +89 -0
- package/types/resources/ItemPrice.d.ts +328 -0
- package/types/resources/Metadata.d.ts +8 -0
- package/types/resources/NonSubscription.d.ts +48 -0
- package/types/resources/Order.d.ts +586 -0
- package/types/resources/PaymentIntent.d.ts +178 -0
- package/types/resources/PaymentReferenceNumber.d.ts +11 -0
- package/types/resources/PaymentSchedule.d.ts +28 -0
- package/types/resources/PaymentScheduleEstimate.d.ts +25 -0
- package/types/resources/PaymentScheduleScheme.d.ts +62 -0
- package/types/resources/PaymentSource.d.ts +529 -0
- package/types/resources/PaymentVoucher.d.ts +107 -0
- package/types/resources/PortalSession.d.ts +88 -0
- package/types/resources/PriceVariant.d.ts +112 -0
- package/types/resources/PricingPageSession.d.ts +130 -0
- package/types/resources/PromotionalCredit.d.ts +111 -0
- package/types/resources/Purchase.d.ts +202 -0
- package/types/resources/Quote.d.ts +1467 -0
- package/types/resources/QuoteLineGroup.d.ts +136 -0
- package/types/resources/QuotedCharge.d.ts +56 -0
- package/types/resources/QuotedSubscription.d.ts +114 -0
- package/types/resources/Ramp.d.ts +260 -0
- package/types/resources/ResourceMigration.d.ts +36 -0
- package/types/resources/SiteMigrationDetail.d.ts +46 -0
- package/types/resources/Subscription.d.ts +2443 -0
- package/types/resources/SubscriptionEntitlement.d.ts +79 -0
- package/types/resources/SubscriptionEstimate.d.ts +59 -0
- package/types/resources/TaxWithheld.d.ts +19 -0
- package/types/resources/ThirdPartyPaymentMethod.d.ts +11 -0
- package/types/resources/TimeMachine.d.ts +57 -0
- package/types/resources/Token.d.ts +19 -0
- package/types/resources/Transaction.d.ts +313 -0
- package/types/resources/UnbilledCharge.d.ts +209 -0
- package/types/resources/Usage.d.ts +113 -0
- package/types/resources/VirtualBankAccount.d.ts +125 -0
- package/types/resources/filter.d.ts +52 -0
|
@@ -0,0 +1,1691 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
///<reference path='./filter.d.ts'/>
|
|
4
|
+
declare module 'chargebee' {
|
|
5
|
+
export interface Invoice {
|
|
6
|
+
id: string;
|
|
7
|
+
po_number?: string;
|
|
8
|
+
customer_id: string;
|
|
9
|
+
subscription_id?: string;
|
|
10
|
+
recurring: boolean;
|
|
11
|
+
status:
|
|
12
|
+
| 'paid'
|
|
13
|
+
| 'posted'
|
|
14
|
+
| 'payment_due'
|
|
15
|
+
| 'not_paid'
|
|
16
|
+
| 'voided'
|
|
17
|
+
| 'pending';
|
|
18
|
+
vat_number?: string;
|
|
19
|
+
price_type: PriceTypeEnum;
|
|
20
|
+
date?: number;
|
|
21
|
+
due_date?: number;
|
|
22
|
+
net_term_days?: number;
|
|
23
|
+
exchange_rate?: number;
|
|
24
|
+
currency_code: string;
|
|
25
|
+
total?: number;
|
|
26
|
+
amount_paid?: number;
|
|
27
|
+
amount_adjusted?: number;
|
|
28
|
+
write_off_amount?: number;
|
|
29
|
+
credits_applied?: number;
|
|
30
|
+
amount_due?: number;
|
|
31
|
+
paid_at?: number;
|
|
32
|
+
dunning_status?: 'in_progress' | 'exhausted' | 'stopped' | 'success';
|
|
33
|
+
next_retry_at?: number;
|
|
34
|
+
voided_at?: number;
|
|
35
|
+
resource_version?: number;
|
|
36
|
+
updated_at?: number;
|
|
37
|
+
sub_total: number;
|
|
38
|
+
sub_total_in_local_currency?: number;
|
|
39
|
+
total_in_local_currency?: number;
|
|
40
|
+
local_currency_code?: string;
|
|
41
|
+
tax: number;
|
|
42
|
+
local_currency_exchange_rate?: number;
|
|
43
|
+
first_invoice?: boolean;
|
|
44
|
+
new_sales_amount?: number;
|
|
45
|
+
has_advance_charges?: boolean;
|
|
46
|
+
term_finalized: boolean;
|
|
47
|
+
is_gifted: boolean;
|
|
48
|
+
generated_at?: number;
|
|
49
|
+
expected_payment_date?: number;
|
|
50
|
+
amount_to_collect?: number;
|
|
51
|
+
round_off_amount?: number;
|
|
52
|
+
line_items?: Invoice.LineItem[];
|
|
53
|
+
discounts?: Invoice.Discount[];
|
|
54
|
+
line_item_discounts?: Invoice.LineItemDiscount[];
|
|
55
|
+
taxes?: Invoice.Tax[];
|
|
56
|
+
line_item_taxes?: Invoice.LineItemTax[];
|
|
57
|
+
line_item_tiers?: Invoice.LineItemTier[];
|
|
58
|
+
linked_payments?: Invoice.LinkedPayment[];
|
|
59
|
+
dunning_attempts?: Invoice.DunningAttempt[];
|
|
60
|
+
applied_credits?: Invoice.AppliedCredit[];
|
|
61
|
+
adjustment_credit_notes?: Invoice.AdjustmentCreditNote[];
|
|
62
|
+
issued_credit_notes?: Invoice.IssuedCreditNote[];
|
|
63
|
+
linked_orders?: Invoice.LinkedOrder[];
|
|
64
|
+
notes?: Invoice.Note[];
|
|
65
|
+
shipping_address?: Invoice.ShippingAddress;
|
|
66
|
+
statement_descriptor?: Invoice.StatementDescriptor;
|
|
67
|
+
billing_address?: Invoice.BillingAddress;
|
|
68
|
+
einvoice?: Invoice.Einvoice;
|
|
69
|
+
payment_owner?: string;
|
|
70
|
+
void_reason_code?: string;
|
|
71
|
+
deleted: boolean;
|
|
72
|
+
tax_category?: string;
|
|
73
|
+
vat_number_prefix?: string;
|
|
74
|
+
channel?: ChannelEnum;
|
|
75
|
+
business_entity_id?: string;
|
|
76
|
+
site_details_at_creation?: Invoice.SiteDetailsAtCreation;
|
|
77
|
+
tax_origin?: Invoice.TaxOrigin;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export namespace Invoice {
|
|
81
|
+
export class InvoiceResource {
|
|
82
|
+
create(
|
|
83
|
+
input?: CreateInputParam,
|
|
84
|
+
headers?: ChargebeeRequestHeader,
|
|
85
|
+
): Promise<ChargebeeResponse<CreateResponse>>;
|
|
86
|
+
|
|
87
|
+
createForChargeItemsAndCharges(
|
|
88
|
+
input: CreateForChargeItemsAndChargesInputParam,
|
|
89
|
+
headers?: ChargebeeRequestHeader,
|
|
90
|
+
): Promise<ChargebeeResponse<CreateForChargeItemsAndChargesResponse>>;
|
|
91
|
+
|
|
92
|
+
charge(
|
|
93
|
+
input: ChargeInputParam,
|
|
94
|
+
headers?: ChargebeeRequestHeader,
|
|
95
|
+
): Promise<ChargebeeResponse<ChargeResponse>>;
|
|
96
|
+
|
|
97
|
+
chargeAddon(
|
|
98
|
+
input: ChargeAddonInputParam,
|
|
99
|
+
headers?: ChargebeeRequestHeader,
|
|
100
|
+
): Promise<ChargebeeResponse<ChargeAddonResponse>>;
|
|
101
|
+
|
|
102
|
+
createForChargeItem(
|
|
103
|
+
input: CreateForChargeItemInputParam,
|
|
104
|
+
headers?: ChargebeeRequestHeader,
|
|
105
|
+
): Promise<ChargebeeResponse<CreateForChargeItemResponse>>;
|
|
106
|
+
|
|
107
|
+
stopDunning(
|
|
108
|
+
invoice_id: string,
|
|
109
|
+
input?: StopDunningInputParam,
|
|
110
|
+
headers?: ChargebeeRequestHeader,
|
|
111
|
+
): Promise<ChargebeeResponse<StopDunningResponse>>;
|
|
112
|
+
|
|
113
|
+
importInvoice(
|
|
114
|
+
input: ImportInvoiceInputParam,
|
|
115
|
+
headers?: ChargebeeRequestHeader,
|
|
116
|
+
): Promise<ChargebeeResponse<ImportInvoiceResponse>>;
|
|
117
|
+
|
|
118
|
+
applyPayments(
|
|
119
|
+
invoice_id: string,
|
|
120
|
+
input?: ApplyPaymentsInputParam,
|
|
121
|
+
headers?: ChargebeeRequestHeader,
|
|
122
|
+
): Promise<ChargebeeResponse<ApplyPaymentsResponse>>;
|
|
123
|
+
|
|
124
|
+
syncUsages(
|
|
125
|
+
invoice_id: string,
|
|
126
|
+
headers?: ChargebeeRequestHeader,
|
|
127
|
+
): Promise<ChargebeeResponse<SyncUsagesResponse>>;
|
|
128
|
+
|
|
129
|
+
deleteLineItems(
|
|
130
|
+
invoice_id: string,
|
|
131
|
+
input?: DeleteLineItemsInputParam,
|
|
132
|
+
headers?: ChargebeeRequestHeader,
|
|
133
|
+
): Promise<ChargebeeResponse<DeleteLineItemsResponse>>;
|
|
134
|
+
|
|
135
|
+
applyCredits(
|
|
136
|
+
invoice_id: string,
|
|
137
|
+
input?: ApplyCreditsInputParam,
|
|
138
|
+
headers?: ChargebeeRequestHeader,
|
|
139
|
+
): Promise<ChargebeeResponse<ApplyCreditsResponse>>;
|
|
140
|
+
|
|
141
|
+
list(
|
|
142
|
+
input?: ListInputParam,
|
|
143
|
+
headers?: ChargebeeRequestHeader,
|
|
144
|
+
): Promise<ChargebeeResponse<ListResponse>>;
|
|
145
|
+
|
|
146
|
+
invoicesForCustomer(
|
|
147
|
+
customer_id: string,
|
|
148
|
+
input?: InvoicesForCustomerInputParam,
|
|
149
|
+
headers?: ChargebeeRequestHeader,
|
|
150
|
+
): Promise<ChargebeeResponse<InvoicesForCustomerResponse>>;
|
|
151
|
+
|
|
152
|
+
invoicesForSubscription(
|
|
153
|
+
subscription_id: string,
|
|
154
|
+
input?: InvoicesForSubscriptionInputParam,
|
|
155
|
+
headers?: ChargebeeRequestHeader,
|
|
156
|
+
): Promise<ChargebeeResponse<InvoicesForSubscriptionResponse>>;
|
|
157
|
+
|
|
158
|
+
retrieve(
|
|
159
|
+
invoice_id: string,
|
|
160
|
+
headers?: ChargebeeRequestHeader,
|
|
161
|
+
): Promise<ChargebeeResponse<RetrieveResponse>>;
|
|
162
|
+
|
|
163
|
+
pdf(
|
|
164
|
+
invoice_id: string,
|
|
165
|
+
input?: PdfInputParam,
|
|
166
|
+
headers?: ChargebeeRequestHeader,
|
|
167
|
+
): Promise<ChargebeeResponse<PdfResponse>>;
|
|
168
|
+
|
|
169
|
+
downloadEinvoice(
|
|
170
|
+
invoice_id: string,
|
|
171
|
+
headers?: ChargebeeRequestHeader,
|
|
172
|
+
): Promise<ChargebeeResponse<DownloadEinvoiceResponse>>;
|
|
173
|
+
|
|
174
|
+
listPaymentReferenceNumbers(
|
|
175
|
+
input?: ListPaymentReferenceNumbersInputParam,
|
|
176
|
+
headers?: ChargebeeRequestHeader,
|
|
177
|
+
): Promise<ChargebeeResponse<ListPaymentReferenceNumbersResponse>>;
|
|
178
|
+
|
|
179
|
+
addCharge(
|
|
180
|
+
invoice_id: string,
|
|
181
|
+
input: AddChargeInputParam,
|
|
182
|
+
headers?: ChargebeeRequestHeader,
|
|
183
|
+
): Promise<ChargebeeResponse<AddChargeResponse>>;
|
|
184
|
+
|
|
185
|
+
addAddonCharge(
|
|
186
|
+
invoice_id: string,
|
|
187
|
+
input: AddAddonChargeInputParam,
|
|
188
|
+
headers?: ChargebeeRequestHeader,
|
|
189
|
+
): Promise<ChargebeeResponse<AddAddonChargeResponse>>;
|
|
190
|
+
|
|
191
|
+
addChargeItem(
|
|
192
|
+
invoice_id: string,
|
|
193
|
+
input: AddChargeItemInputParam,
|
|
194
|
+
headers?: ChargebeeRequestHeader,
|
|
195
|
+
): Promise<ChargebeeResponse<AddChargeItemResponse>>;
|
|
196
|
+
|
|
197
|
+
close(
|
|
198
|
+
invoice_id: string,
|
|
199
|
+
input?: CloseInputParam,
|
|
200
|
+
headers?: ChargebeeRequestHeader,
|
|
201
|
+
): Promise<ChargebeeResponse<CloseResponse>>;
|
|
202
|
+
|
|
203
|
+
collectPayment(
|
|
204
|
+
invoice_id: string,
|
|
205
|
+
input?: CollectPaymentInputParam,
|
|
206
|
+
headers?: ChargebeeRequestHeader,
|
|
207
|
+
): Promise<ChargebeeResponse<CollectPaymentResponse>>;
|
|
208
|
+
|
|
209
|
+
recordPayment(
|
|
210
|
+
invoice_id: string,
|
|
211
|
+
input: RecordPaymentInputParam,
|
|
212
|
+
headers?: ChargebeeRequestHeader,
|
|
213
|
+
): Promise<ChargebeeResponse<RecordPaymentResponse>>;
|
|
214
|
+
|
|
215
|
+
recordTaxWithheld(
|
|
216
|
+
invoice_id: string,
|
|
217
|
+
input: RecordTaxWithheldInputParam,
|
|
218
|
+
headers?: ChargebeeRequestHeader,
|
|
219
|
+
): Promise<ChargebeeResponse<RecordTaxWithheldResponse>>;
|
|
220
|
+
|
|
221
|
+
removeTaxWithheld(
|
|
222
|
+
invoice_id: string,
|
|
223
|
+
input: RemoveTaxWithheldInputParam,
|
|
224
|
+
headers?: ChargebeeRequestHeader,
|
|
225
|
+
): Promise<ChargebeeResponse<RemoveTaxWithheldResponse>>;
|
|
226
|
+
|
|
227
|
+
refund(
|
|
228
|
+
invoice_id: string,
|
|
229
|
+
input?: RefundInputParam,
|
|
230
|
+
headers?: ChargebeeRequestHeader,
|
|
231
|
+
): Promise<ChargebeeResponse<RefundResponse>>;
|
|
232
|
+
|
|
233
|
+
recordRefund(
|
|
234
|
+
invoice_id: string,
|
|
235
|
+
input: RecordRefundInputParam,
|
|
236
|
+
headers?: ChargebeeRequestHeader,
|
|
237
|
+
): Promise<ChargebeeResponse<RecordRefundResponse>>;
|
|
238
|
+
|
|
239
|
+
removePayment(
|
|
240
|
+
invoice_id: string,
|
|
241
|
+
input: RemovePaymentInputParam,
|
|
242
|
+
headers?: ChargebeeRequestHeader,
|
|
243
|
+
): Promise<ChargebeeResponse<RemovePaymentResponse>>;
|
|
244
|
+
|
|
245
|
+
removeCreditNote(
|
|
246
|
+
invoice_id: string,
|
|
247
|
+
input: RemoveCreditNoteInputParam,
|
|
248
|
+
headers?: ChargebeeRequestHeader,
|
|
249
|
+
): Promise<ChargebeeResponse<RemoveCreditNoteResponse>>;
|
|
250
|
+
|
|
251
|
+
voidInvoice(
|
|
252
|
+
invoice_id: string,
|
|
253
|
+
input?: VoidInvoiceInputParam,
|
|
254
|
+
headers?: ChargebeeRequestHeader,
|
|
255
|
+
): Promise<ChargebeeResponse<VoidInvoiceResponse>>;
|
|
256
|
+
|
|
257
|
+
writeOff(
|
|
258
|
+
invoice_id: string,
|
|
259
|
+
input?: WriteOffInputParam,
|
|
260
|
+
headers?: ChargebeeRequestHeader,
|
|
261
|
+
): Promise<ChargebeeResponse<WriteOffResponse>>;
|
|
262
|
+
|
|
263
|
+
delete(
|
|
264
|
+
invoice_id: string,
|
|
265
|
+
input?: DeleteInputParam,
|
|
266
|
+
headers?: ChargebeeRequestHeader,
|
|
267
|
+
): Promise<ChargebeeResponse<DeleteResponse>>;
|
|
268
|
+
|
|
269
|
+
updateDetails(
|
|
270
|
+
invoice_id: string,
|
|
271
|
+
input?: UpdateDetailsInputParam,
|
|
272
|
+
headers?: ChargebeeRequestHeader,
|
|
273
|
+
): Promise<ChargebeeResponse<UpdateDetailsResponse>>;
|
|
274
|
+
|
|
275
|
+
applyPaymentScheduleScheme(
|
|
276
|
+
invoice_id: string,
|
|
277
|
+
input: ApplyPaymentScheduleSchemeInputParam,
|
|
278
|
+
headers?: ChargebeeRequestHeader,
|
|
279
|
+
): Promise<ChargebeeResponse<ApplyPaymentScheduleSchemeResponse>>;
|
|
280
|
+
|
|
281
|
+
paymentSchedules(
|
|
282
|
+
invoice_id: string,
|
|
283
|
+
headers?: ChargebeeRequestHeader,
|
|
284
|
+
): Promise<ChargebeeResponse<PaymentSchedulesResponse>>;
|
|
285
|
+
|
|
286
|
+
resendEinvoice(
|
|
287
|
+
invoice_id: string,
|
|
288
|
+
headers?: ChargebeeRequestHeader,
|
|
289
|
+
): Promise<ChargebeeResponse<ResendEinvoiceResponse>>;
|
|
290
|
+
|
|
291
|
+
sendEinvoice(
|
|
292
|
+
invoice_id: string,
|
|
293
|
+
headers?: ChargebeeRequestHeader,
|
|
294
|
+
): Promise<ChargebeeResponse<SendEinvoiceResponse>>;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
export interface CreateResponse {
|
|
298
|
+
invoice: Invoice;
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
export interface CreateForChargeItemsAndChargesResponse {
|
|
302
|
+
invoice: Invoice;
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
export interface ChargeResponse {
|
|
306
|
+
invoice: Invoice;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
export interface ChargeAddonResponse {
|
|
310
|
+
invoice: Invoice;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
export interface CreateForChargeItemResponse {
|
|
314
|
+
invoice: Invoice;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
export interface StopDunningResponse {
|
|
318
|
+
invoice: Invoice;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
export interface ImportInvoiceResponse {
|
|
322
|
+
invoice: Invoice;
|
|
323
|
+
credit_note?: CreditNote;
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
export interface ApplyPaymentsResponse {
|
|
327
|
+
invoice: Invoice;
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
export interface SyncUsagesResponse {
|
|
331
|
+
invoice: Invoice;
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
export interface DeleteLineItemsResponse {
|
|
335
|
+
invoice: Invoice;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
export interface ApplyCreditsResponse {
|
|
339
|
+
invoice: Invoice;
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
export interface ListResponse {
|
|
343
|
+
list: { invoice: Invoice }[];
|
|
344
|
+
next_offset?: string;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
export interface InvoicesForCustomerResponse {
|
|
348
|
+
list: { invoice: Invoice }[];
|
|
349
|
+
next_offset?: string;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
export interface InvoicesForSubscriptionResponse {
|
|
353
|
+
list: { invoice: Invoice }[];
|
|
354
|
+
next_offset?: string;
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
export interface RetrieveResponse {
|
|
358
|
+
invoice: Invoice;
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
export interface PdfResponse {
|
|
362
|
+
download: Download;
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
export interface DownloadEinvoiceResponse {
|
|
366
|
+
downloads: Download[];
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
export interface ListPaymentReferenceNumbersResponse {
|
|
370
|
+
list: { payment_reference_number: PaymentReferenceNumber }[];
|
|
371
|
+
next_offset?: string;
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
export interface AddChargeResponse {
|
|
375
|
+
invoice: Invoice;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
export interface AddAddonChargeResponse {
|
|
379
|
+
invoice: Invoice;
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
export interface AddChargeItemResponse {
|
|
383
|
+
invoice: Invoice;
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
export interface CloseResponse {
|
|
387
|
+
invoice: Invoice;
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
export interface CollectPaymentResponse {
|
|
391
|
+
invoice: Invoice;
|
|
392
|
+
transaction: Transaction;
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
export interface RecordPaymentResponse {
|
|
396
|
+
invoice: Invoice;
|
|
397
|
+
transaction: Transaction;
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
export interface RecordTaxWithheldResponse {
|
|
401
|
+
invoice: Invoice;
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
export interface RemoveTaxWithheldResponse {
|
|
405
|
+
invoice: Invoice;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
export interface RefundResponse {
|
|
409
|
+
invoice: Invoice;
|
|
410
|
+
transaction: Transaction;
|
|
411
|
+
credit_note?: CreditNote;
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
export interface RecordRefundResponse {
|
|
415
|
+
invoice: Invoice;
|
|
416
|
+
transaction?: Transaction;
|
|
417
|
+
credit_note?: CreditNote;
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
export interface RemovePaymentResponse {
|
|
421
|
+
invoice: Invoice;
|
|
422
|
+
transaction: Transaction;
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
export interface RemoveCreditNoteResponse {
|
|
426
|
+
invoice: Invoice;
|
|
427
|
+
credit_note: CreditNote;
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
export interface VoidInvoiceResponse {
|
|
431
|
+
invoice: Invoice;
|
|
432
|
+
credit_note?: CreditNote;
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
export interface WriteOffResponse {
|
|
436
|
+
invoice: Invoice;
|
|
437
|
+
credit_note: CreditNote;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
export interface DeleteResponse {
|
|
441
|
+
invoice: Invoice;
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
export interface UpdateDetailsResponse {
|
|
445
|
+
invoice: Invoice;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
export interface ApplyPaymentScheduleSchemeResponse {
|
|
449
|
+
invoice: Invoice;
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
export interface PaymentSchedulesResponse {
|
|
453
|
+
payment_schedules: PaymentSchedule[];
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
export interface ResendEinvoiceResponse {
|
|
457
|
+
invoice: Invoice;
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
export interface SendEinvoiceResponse {
|
|
461
|
+
invoice: Invoice;
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
export interface LineItem {
|
|
465
|
+
id?: string;
|
|
466
|
+
subscription_id?: string;
|
|
467
|
+
date_from: number;
|
|
468
|
+
date_to: number;
|
|
469
|
+
unit_amount: number;
|
|
470
|
+
quantity?: number;
|
|
471
|
+
amount?: number;
|
|
472
|
+
pricing_model?:
|
|
473
|
+
| 'flat_fee'
|
|
474
|
+
| 'per_unit'
|
|
475
|
+
| 'tiered'
|
|
476
|
+
| 'volume'
|
|
477
|
+
| 'stairstep';
|
|
478
|
+
is_taxed: boolean;
|
|
479
|
+
tax_amount?: number;
|
|
480
|
+
tax_rate?: number;
|
|
481
|
+
unit_amount_in_decimal?: string;
|
|
482
|
+
quantity_in_decimal?: string;
|
|
483
|
+
amount_in_decimal?: string;
|
|
484
|
+
discount_amount?: number;
|
|
485
|
+
item_level_discount_amount?: number;
|
|
486
|
+
usage_percentage?: string;
|
|
487
|
+
reference_line_item_id?: string;
|
|
488
|
+
description: string;
|
|
489
|
+
entity_description?: string;
|
|
490
|
+
entity_type:
|
|
491
|
+
| 'adhoc'
|
|
492
|
+
| 'plan_item_price'
|
|
493
|
+
| 'addon_item_price'
|
|
494
|
+
| 'charge_item_price'
|
|
495
|
+
| 'plan_setup'
|
|
496
|
+
| 'plan'
|
|
497
|
+
| 'addon';
|
|
498
|
+
tax_exempt_reason?:
|
|
499
|
+
| 'tax_not_configured'
|
|
500
|
+
| 'region_non_taxable'
|
|
501
|
+
| 'export'
|
|
502
|
+
| 'customer_exempt'
|
|
503
|
+
| 'product_exempt'
|
|
504
|
+
| 'zero_rated'
|
|
505
|
+
| 'reverse_charge'
|
|
506
|
+
| 'high_value_physical_goods'
|
|
507
|
+
| 'zero_value_item'
|
|
508
|
+
| 'tax_not_configured_external_provider';
|
|
509
|
+
entity_id?: string;
|
|
510
|
+
customer_id?: string;
|
|
511
|
+
}
|
|
512
|
+
export interface Discount {
|
|
513
|
+
amount: number;
|
|
514
|
+
description?: string;
|
|
515
|
+
entity_type:
|
|
516
|
+
| 'item_level_coupon'
|
|
517
|
+
| 'document_level_coupon'
|
|
518
|
+
| 'promotional_credits'
|
|
519
|
+
| 'prorated_credits'
|
|
520
|
+
| 'item_level_discount'
|
|
521
|
+
| 'document_level_discount';
|
|
522
|
+
entity_id?: string;
|
|
523
|
+
coupon_set_code?: string;
|
|
524
|
+
}
|
|
525
|
+
export interface LineItemDiscount {
|
|
526
|
+
line_item_id: string;
|
|
527
|
+
discount_type:
|
|
528
|
+
| 'item_level_coupon'
|
|
529
|
+
| 'document_level_coupon'
|
|
530
|
+
| 'promotional_credits'
|
|
531
|
+
| 'prorated_credits'
|
|
532
|
+
| 'item_level_discount'
|
|
533
|
+
| 'document_level_discount';
|
|
534
|
+
coupon_id?: string;
|
|
535
|
+
entity_id?: string;
|
|
536
|
+
discount_amount: number;
|
|
537
|
+
}
|
|
538
|
+
export interface Tax {
|
|
539
|
+
name: string;
|
|
540
|
+
amount: number;
|
|
541
|
+
description?: string;
|
|
542
|
+
}
|
|
543
|
+
export interface LineItemTax {
|
|
544
|
+
line_item_id?: string;
|
|
545
|
+
tax_name: string;
|
|
546
|
+
tax_rate: number;
|
|
547
|
+
date_to?: number;
|
|
548
|
+
date_from?: number;
|
|
549
|
+
prorated_taxable_amount?: number;
|
|
550
|
+
is_partial_tax_applied?: boolean;
|
|
551
|
+
is_non_compliance_tax?: boolean;
|
|
552
|
+
taxable_amount: number;
|
|
553
|
+
tax_amount: number;
|
|
554
|
+
tax_juris_type?:
|
|
555
|
+
| 'country'
|
|
556
|
+
| 'federal'
|
|
557
|
+
| 'state'
|
|
558
|
+
| 'county'
|
|
559
|
+
| 'city'
|
|
560
|
+
| 'special'
|
|
561
|
+
| 'unincorporated'
|
|
562
|
+
| 'other';
|
|
563
|
+
tax_juris_name?: string;
|
|
564
|
+
tax_juris_code?: string;
|
|
565
|
+
tax_amount_in_local_currency?: number;
|
|
566
|
+
local_currency_code?: string;
|
|
567
|
+
}
|
|
568
|
+
export interface LineItemTier {
|
|
569
|
+
line_item_id?: string;
|
|
570
|
+
starting_unit: number;
|
|
571
|
+
ending_unit?: number;
|
|
572
|
+
quantity_used: number;
|
|
573
|
+
unit_amount: number;
|
|
574
|
+
starting_unit_in_decimal?: string;
|
|
575
|
+
ending_unit_in_decimal?: string;
|
|
576
|
+
quantity_used_in_decimal?: string;
|
|
577
|
+
unit_amount_in_decimal?: string;
|
|
578
|
+
}
|
|
579
|
+
export interface LinkedPayment {
|
|
580
|
+
txn_id: string;
|
|
581
|
+
applied_amount: number;
|
|
582
|
+
applied_at: number;
|
|
583
|
+
txn_status?:
|
|
584
|
+
| 'in_progress'
|
|
585
|
+
| 'success'
|
|
586
|
+
| 'voided'
|
|
587
|
+
| 'failure'
|
|
588
|
+
| 'timeout'
|
|
589
|
+
| 'needs_attention';
|
|
590
|
+
txn_date?: number;
|
|
591
|
+
txn_amount?: number;
|
|
592
|
+
}
|
|
593
|
+
export interface DunningAttempt {
|
|
594
|
+
attempt: number;
|
|
595
|
+
transaction_id?: string;
|
|
596
|
+
dunning_type: 'auto_collect' | 'offline' | 'direct_debit';
|
|
597
|
+
created_at?: number;
|
|
598
|
+
txn_status?:
|
|
599
|
+
| 'in_progress'
|
|
600
|
+
| 'success'
|
|
601
|
+
| 'voided'
|
|
602
|
+
| 'failure'
|
|
603
|
+
| 'timeout'
|
|
604
|
+
| 'needs_attention';
|
|
605
|
+
txn_amount?: number;
|
|
606
|
+
}
|
|
607
|
+
export interface AppliedCredit {
|
|
608
|
+
cn_id: string;
|
|
609
|
+
applied_amount: number;
|
|
610
|
+
applied_at: number;
|
|
611
|
+
cn_reason_code?:
|
|
612
|
+
| 'write_off'
|
|
613
|
+
| 'subscription_change'
|
|
614
|
+
| 'subscription_cancellation'
|
|
615
|
+
| 'subscription_pause'
|
|
616
|
+
| 'chargeback'
|
|
617
|
+
| 'product_unsatisfactory'
|
|
618
|
+
| 'service_unsatisfactory'
|
|
619
|
+
| 'order_change'
|
|
620
|
+
| 'order_cancellation'
|
|
621
|
+
| 'waiver'
|
|
622
|
+
| 'other'
|
|
623
|
+
| 'fraudulent';
|
|
624
|
+
cn_create_reason_code?: string;
|
|
625
|
+
cn_date?: number;
|
|
626
|
+
cn_status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
|
|
627
|
+
}
|
|
628
|
+
export interface AdjustmentCreditNote {
|
|
629
|
+
cn_id: string;
|
|
630
|
+
cn_reason_code?:
|
|
631
|
+
| 'write_off'
|
|
632
|
+
| 'subscription_change'
|
|
633
|
+
| 'subscription_cancellation'
|
|
634
|
+
| 'subscription_pause'
|
|
635
|
+
| 'chargeback'
|
|
636
|
+
| 'product_unsatisfactory'
|
|
637
|
+
| 'service_unsatisfactory'
|
|
638
|
+
| 'order_change'
|
|
639
|
+
| 'order_cancellation'
|
|
640
|
+
| 'waiver'
|
|
641
|
+
| 'other'
|
|
642
|
+
| 'fraudulent';
|
|
643
|
+
cn_create_reason_code?: string;
|
|
644
|
+
cn_date?: number;
|
|
645
|
+
cn_total?: number;
|
|
646
|
+
cn_status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
|
|
647
|
+
}
|
|
648
|
+
export interface IssuedCreditNote {
|
|
649
|
+
cn_id: string;
|
|
650
|
+
cn_reason_code?:
|
|
651
|
+
| 'write_off'
|
|
652
|
+
| 'subscription_change'
|
|
653
|
+
| 'subscription_cancellation'
|
|
654
|
+
| 'subscription_pause'
|
|
655
|
+
| 'chargeback'
|
|
656
|
+
| 'product_unsatisfactory'
|
|
657
|
+
| 'service_unsatisfactory'
|
|
658
|
+
| 'order_change'
|
|
659
|
+
| 'order_cancellation'
|
|
660
|
+
| 'waiver'
|
|
661
|
+
| 'other'
|
|
662
|
+
| 'fraudulent';
|
|
663
|
+
cn_create_reason_code?: string;
|
|
664
|
+
cn_date?: number;
|
|
665
|
+
cn_total?: number;
|
|
666
|
+
cn_status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
|
|
667
|
+
}
|
|
668
|
+
export interface LinkedOrder {
|
|
669
|
+
id: string;
|
|
670
|
+
document_number?: string;
|
|
671
|
+
status?:
|
|
672
|
+
| 'new'
|
|
673
|
+
| 'processing'
|
|
674
|
+
| 'complete'
|
|
675
|
+
| 'cancelled'
|
|
676
|
+
| 'voided'
|
|
677
|
+
| 'queued'
|
|
678
|
+
| 'awaiting_shipment'
|
|
679
|
+
| 'on_hold'
|
|
680
|
+
| 'delivered'
|
|
681
|
+
| 'shipped'
|
|
682
|
+
| 'partially_delivered'
|
|
683
|
+
| 'returned';
|
|
684
|
+
order_type?: 'manual' | 'system_generated';
|
|
685
|
+
reference_id?: string;
|
|
686
|
+
fulfillment_status?: string;
|
|
687
|
+
batch_id?: string;
|
|
688
|
+
created_at: number;
|
|
689
|
+
}
|
|
690
|
+
export interface Note {
|
|
691
|
+
entity_type:
|
|
692
|
+
| 'coupon'
|
|
693
|
+
| 'subscription'
|
|
694
|
+
| 'customer'
|
|
695
|
+
| 'plan_item_price'
|
|
696
|
+
| 'addon_item_price'
|
|
697
|
+
| 'charge_item_price'
|
|
698
|
+
| 'tax'
|
|
699
|
+
| 'plan'
|
|
700
|
+
| 'addon';
|
|
701
|
+
note: string;
|
|
702
|
+
entity_id?: string;
|
|
703
|
+
}
|
|
704
|
+
export interface ShippingAddress {
|
|
705
|
+
first_name?: string;
|
|
706
|
+
last_name?: string;
|
|
707
|
+
email?: string;
|
|
708
|
+
company?: string;
|
|
709
|
+
phone?: string;
|
|
710
|
+
line1?: string;
|
|
711
|
+
line2?: string;
|
|
712
|
+
line3?: string;
|
|
713
|
+
city?: string;
|
|
714
|
+
state_code?: string;
|
|
715
|
+
state?: string;
|
|
716
|
+
country?: string;
|
|
717
|
+
zip?: string;
|
|
718
|
+
validation_status?: ValidationStatusEnum;
|
|
719
|
+
index: number;
|
|
720
|
+
}
|
|
721
|
+
export interface StatementDescriptor {
|
|
722
|
+
id: string;
|
|
723
|
+
descriptor?: string;
|
|
724
|
+
}
|
|
725
|
+
export interface BillingAddress {
|
|
726
|
+
first_name?: string;
|
|
727
|
+
last_name?: string;
|
|
728
|
+
email?: string;
|
|
729
|
+
company?: string;
|
|
730
|
+
phone?: string;
|
|
731
|
+
line1?: string;
|
|
732
|
+
line2?: string;
|
|
733
|
+
line3?: string;
|
|
734
|
+
city?: string;
|
|
735
|
+
state_code?: string;
|
|
736
|
+
state?: string;
|
|
737
|
+
country?: string;
|
|
738
|
+
zip?: string;
|
|
739
|
+
validation_status?: ValidationStatusEnum;
|
|
740
|
+
}
|
|
741
|
+
export interface Einvoice {
|
|
742
|
+
id: string;
|
|
743
|
+
reference_number?: string;
|
|
744
|
+
status:
|
|
745
|
+
| 'scheduled'
|
|
746
|
+
| 'skipped'
|
|
747
|
+
| 'in_progress'
|
|
748
|
+
| 'success'
|
|
749
|
+
| 'failed'
|
|
750
|
+
| 'registered';
|
|
751
|
+
message?: string;
|
|
752
|
+
}
|
|
753
|
+
export interface SiteDetailsAtCreation {
|
|
754
|
+
timezone?: string;
|
|
755
|
+
organization_address?: object;
|
|
756
|
+
}
|
|
757
|
+
export interface TaxOrigin {
|
|
758
|
+
country?: string;
|
|
759
|
+
registration_number?: string;
|
|
760
|
+
}
|
|
761
|
+
// REQUEST PARAMS
|
|
762
|
+
//---------------
|
|
763
|
+
|
|
764
|
+
export interface CreateInputParam {
|
|
765
|
+
customer_id?: string;
|
|
766
|
+
subscription_id?: string;
|
|
767
|
+
currency_code?: string;
|
|
768
|
+
invoice_date?: number;
|
|
769
|
+
invoice_note?: string;
|
|
770
|
+
remove_general_note?: boolean;
|
|
771
|
+
po_number?: string /**
|
|
772
|
+
* @deprecated Please refer API docs to use other attributes
|
|
773
|
+
*/;
|
|
774
|
+
|
|
775
|
+
coupon?: string;
|
|
776
|
+
coupon_ids?: string[];
|
|
777
|
+
authorization_transaction_id?: string;
|
|
778
|
+
payment_source_id?: string;
|
|
779
|
+
auto_collection?: AutoCollectionEnum;
|
|
780
|
+
token_id?: string;
|
|
781
|
+
replace_primary_payment_source?: boolean;
|
|
782
|
+
retain_payment_source?: boolean;
|
|
783
|
+
payment_initiator?: PaymentInitiatorEnum;
|
|
784
|
+
shipping_address?: ShippingAddressCreateInputParam;
|
|
785
|
+
statement_descriptor?: StatementDescriptorCreateInputParam;
|
|
786
|
+
card?: CardCreateInputParam;
|
|
787
|
+
bank_account?: BankAccountCreateInputParam;
|
|
788
|
+
payment_method?: PaymentMethodCreateInputParam;
|
|
789
|
+
payment_intent?: PaymentIntentCreateInputParam;
|
|
790
|
+
addons?: AddonsCreateInputParam[];
|
|
791
|
+
charges?: ChargesCreateInputParam[];
|
|
792
|
+
tax_providers_fields?: TaxProvidersFieldsCreateInputParam[];
|
|
793
|
+
notes_to_remove?: NotesToRemoveCreateInputParam[];
|
|
794
|
+
}
|
|
795
|
+
export interface CreateForChargeItemsAndChargesInputParam {
|
|
796
|
+
customer_id?: string;
|
|
797
|
+
subscription_id?: string;
|
|
798
|
+
currency_code?: string;
|
|
799
|
+
invoice_note?: string;
|
|
800
|
+
remove_general_note?: boolean;
|
|
801
|
+
po_number?: string /**
|
|
802
|
+
* @deprecated Please refer API docs to use other attributes
|
|
803
|
+
*/;
|
|
804
|
+
|
|
805
|
+
coupon?: string;
|
|
806
|
+
coupon_ids?: string[];
|
|
807
|
+
authorization_transaction_id?: string;
|
|
808
|
+
payment_source_id?: string;
|
|
809
|
+
auto_collection?: AutoCollectionEnum;
|
|
810
|
+
invoice_date?: number;
|
|
811
|
+
token_id?: string;
|
|
812
|
+
replace_primary_payment_source?: boolean;
|
|
813
|
+
retain_payment_source?: boolean;
|
|
814
|
+
payment_initiator?: PaymentInitiatorEnum;
|
|
815
|
+
shipping_address?: ShippingAddressCreateForChargeItemsAndChargesInputParam;
|
|
816
|
+
statement_descriptor?: StatementDescriptorCreateForChargeItemsAndChargesInputParam;
|
|
817
|
+
card?: CardCreateForChargeItemsAndChargesInputParam;
|
|
818
|
+
bank_account?: BankAccountCreateForChargeItemsAndChargesInputParam;
|
|
819
|
+
payment_method?: PaymentMethodCreateForChargeItemsAndChargesInputParam;
|
|
820
|
+
payment_intent?: PaymentIntentCreateForChargeItemsAndChargesInputParam;
|
|
821
|
+
item_prices?: ItemPricesCreateForChargeItemsAndChargesInputParam[];
|
|
822
|
+
item_tiers?: ItemTiersCreateForChargeItemsAndChargesInputParam[];
|
|
823
|
+
charges?: ChargesCreateForChargeItemsAndChargesInputParam[];
|
|
824
|
+
notes_to_remove?: NotesToRemoveCreateForChargeItemsAndChargesInputParam[];
|
|
825
|
+
tax_providers_fields?: TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam[];
|
|
826
|
+
discounts?: DiscountsCreateForChargeItemsAndChargesInputParam[];
|
|
827
|
+
}
|
|
828
|
+
export interface ChargeInputParam {
|
|
829
|
+
customer_id?: string;
|
|
830
|
+
subscription_id?: string;
|
|
831
|
+
currency_code?: string;
|
|
832
|
+
amount?: number;
|
|
833
|
+
amount_in_decimal?: string;
|
|
834
|
+
description: string;
|
|
835
|
+
date_from?: number;
|
|
836
|
+
date_to?: number;
|
|
837
|
+
coupon_ids?: string[] /**
|
|
838
|
+
* @deprecated Please refer API docs to use other attributes
|
|
839
|
+
*/;
|
|
840
|
+
|
|
841
|
+
coupon?: string;
|
|
842
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
843
|
+
avalara_transaction_type?: number;
|
|
844
|
+
avalara_service_type?: number;
|
|
845
|
+
po_number?: string;
|
|
846
|
+
invoice_date?: number;
|
|
847
|
+
payment_source_id?: string;
|
|
848
|
+
payment_initiator?: PaymentInitiatorEnum;
|
|
849
|
+
tax_providers_fields?: TaxProvidersFieldsChargeInputParam[];
|
|
850
|
+
}
|
|
851
|
+
export interface ChargeAddonInputParam {
|
|
852
|
+
customer_id?: string;
|
|
853
|
+
subscription_id?: string;
|
|
854
|
+
addon_id: string;
|
|
855
|
+
addon_quantity?: number;
|
|
856
|
+
addon_unit_price?: number;
|
|
857
|
+
addon_quantity_in_decimal?: string;
|
|
858
|
+
addon_unit_price_in_decimal?: string;
|
|
859
|
+
date_from?: number;
|
|
860
|
+
date_to?: number;
|
|
861
|
+
coupon_ids?: string[] /**
|
|
862
|
+
* @deprecated Please refer API docs to use other attributes
|
|
863
|
+
*/;
|
|
864
|
+
|
|
865
|
+
coupon?: string;
|
|
866
|
+
po_number?: string;
|
|
867
|
+
invoice_date?: number;
|
|
868
|
+
payment_source_id?: string;
|
|
869
|
+
payment_initiator?: PaymentInitiatorEnum;
|
|
870
|
+
}
|
|
871
|
+
export interface CreateForChargeItemInputParam {
|
|
872
|
+
customer_id?: string;
|
|
873
|
+
subscription_id?: string;
|
|
874
|
+
po_number?: string;
|
|
875
|
+
coupon?: string;
|
|
876
|
+
payment_source_id?: string;
|
|
877
|
+
payment_initiator?: PaymentInitiatorEnum;
|
|
878
|
+
invoice_date?: number;
|
|
879
|
+
item_price?: ItemPriceCreateForChargeItemInputParam;
|
|
880
|
+
item_tiers?: ItemTiersCreateForChargeItemInputParam[];
|
|
881
|
+
}
|
|
882
|
+
export interface StopDunningInputParam {
|
|
883
|
+
comment?: string;
|
|
884
|
+
}
|
|
885
|
+
export interface ImportInvoiceInputParam {
|
|
886
|
+
id: string;
|
|
887
|
+
currency_code?: string;
|
|
888
|
+
customer_id?: string;
|
|
889
|
+
subscription_id?: string;
|
|
890
|
+
po_number?: string;
|
|
891
|
+
price_type?: PriceTypeEnum;
|
|
892
|
+
tax_override_reason?: TaxOverrideReasonEnum;
|
|
893
|
+
vat_number?: string;
|
|
894
|
+
vat_number_prefix?: string;
|
|
895
|
+
date: number;
|
|
896
|
+
total: number;
|
|
897
|
+
round_off?: number;
|
|
898
|
+
status?:
|
|
899
|
+
| 'paid'
|
|
900
|
+
| 'posted'
|
|
901
|
+
| 'payment_due'
|
|
902
|
+
| 'not_paid'
|
|
903
|
+
| 'voided'
|
|
904
|
+
| 'pending';
|
|
905
|
+
voided_at?: number;
|
|
906
|
+
void_reason_code?: string;
|
|
907
|
+
is_written_off?: boolean;
|
|
908
|
+
write_off_amount?: number;
|
|
909
|
+
write_off_date?: number;
|
|
910
|
+
due_date?: number;
|
|
911
|
+
net_term_days?: number;
|
|
912
|
+
has_advance_charges?: boolean;
|
|
913
|
+
use_for_proration?: boolean;
|
|
914
|
+
credit_note?: CreditNoteImportInvoiceInputParam;
|
|
915
|
+
billing_address?: BillingAddressImportInvoiceInputParam;
|
|
916
|
+
shipping_address?: ShippingAddressImportInvoiceInputParam;
|
|
917
|
+
line_items?: LineItemsImportInvoiceInputParam[];
|
|
918
|
+
payment_reference_numbers?: PaymentReferenceNumbersImportInvoiceInputParam[];
|
|
919
|
+
line_item_tiers?: LineItemTiersImportInvoiceInputParam[];
|
|
920
|
+
discounts?: DiscountsImportInvoiceInputParam[];
|
|
921
|
+
taxes?: TaxesImportInvoiceInputParam[];
|
|
922
|
+
payments?: PaymentsImportInvoiceInputParam[];
|
|
923
|
+
notes?: NotesImportInvoiceInputParam[];
|
|
924
|
+
}
|
|
925
|
+
export interface ApplyPaymentsInputParam {
|
|
926
|
+
comment?: string;
|
|
927
|
+
transactions?: TransactionsApplyPaymentsInputParam[];
|
|
928
|
+
}
|
|
929
|
+
export interface DeleteLineItemsInputParam {
|
|
930
|
+
line_items?: LineItemsDeleteLineItemsInputParam[];
|
|
931
|
+
}
|
|
932
|
+
export interface ApplyCreditsInputParam {
|
|
933
|
+
comment?: string;
|
|
934
|
+
credit_notes?: CreditNotesApplyCreditsInputParam[];
|
|
935
|
+
}
|
|
936
|
+
export interface ListInputParam {
|
|
937
|
+
limit?: number;
|
|
938
|
+
offset?: string;
|
|
939
|
+
einvoice?: EinvoiceInvoiceListInputParam /**
|
|
940
|
+
* @deprecated Please refer API docs to use other attributes
|
|
941
|
+
*/;
|
|
942
|
+
|
|
943
|
+
paid_on_after?: number;
|
|
944
|
+
include_deleted?: boolean;
|
|
945
|
+
id?: filter.String;
|
|
946
|
+
subscription_id?: filter.String;
|
|
947
|
+
customer_id?: filter.String;
|
|
948
|
+
recurring?: filter.Boolean;
|
|
949
|
+
status?: filter.Enum;
|
|
950
|
+
price_type?: filter.Enum;
|
|
951
|
+
date?: filter.Timestamp;
|
|
952
|
+
paid_at?: filter.Timestamp;
|
|
953
|
+
total?: filter.Number;
|
|
954
|
+
amount_paid?: filter.Number;
|
|
955
|
+
amount_adjusted?: filter.Number;
|
|
956
|
+
credits_applied?: filter.Number;
|
|
957
|
+
amount_due?: filter.Number;
|
|
958
|
+
dunning_status?: filter.Enum;
|
|
959
|
+
payment_owner?: filter.String;
|
|
960
|
+
updated_at?: filter.Timestamp;
|
|
961
|
+
channel?: filter.Enum;
|
|
962
|
+
voided_at?: filter.Timestamp;
|
|
963
|
+
void_reason_code?: filter.String;
|
|
964
|
+
'sort_by[asc]'?: string;
|
|
965
|
+
'sort_by[desc]'?: string;
|
|
966
|
+
}
|
|
967
|
+
export interface InvoicesForCustomerInputParam {
|
|
968
|
+
limit?: number;
|
|
969
|
+
offset?: string;
|
|
970
|
+
}
|
|
971
|
+
export interface InvoicesForSubscriptionInputParam {
|
|
972
|
+
limit?: number;
|
|
973
|
+
offset?: string;
|
|
974
|
+
}
|
|
975
|
+
export interface PdfInputParam {
|
|
976
|
+
disposition_type?: DispositionTypeEnum;
|
|
977
|
+
}
|
|
978
|
+
export interface ListPaymentReferenceNumbersInputParam {
|
|
979
|
+
limit?: number;
|
|
980
|
+
offset?: string;
|
|
981
|
+
payment_reference_number?: PaymentReferenceNumberInvoiceListPaymentReferenceNumbersInputParam;
|
|
982
|
+
id?: filter.String;
|
|
983
|
+
}
|
|
984
|
+
export interface AddChargeInputParam {
|
|
985
|
+
amount: number;
|
|
986
|
+
description: string;
|
|
987
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
988
|
+
avalara_transaction_type?: number;
|
|
989
|
+
avalara_service_type?: number;
|
|
990
|
+
avalara_tax_code?: string;
|
|
991
|
+
hsn_code?: string;
|
|
992
|
+
taxjar_product_code?: string;
|
|
993
|
+
comment?: string;
|
|
994
|
+
subscription_id?: string;
|
|
995
|
+
line_item?: LineItemAddChargeInputParam;
|
|
996
|
+
}
|
|
997
|
+
export interface AddAddonChargeInputParam {
|
|
998
|
+
addon_id: string;
|
|
999
|
+
addon_quantity?: number;
|
|
1000
|
+
addon_unit_price?: number;
|
|
1001
|
+
addon_quantity_in_decimal?: string;
|
|
1002
|
+
addon_unit_price_in_decimal?: string;
|
|
1003
|
+
comment?: string;
|
|
1004
|
+
subscription_id?: string;
|
|
1005
|
+
line_item?: LineItemAddAddonChargeInputParam;
|
|
1006
|
+
}
|
|
1007
|
+
export interface AddChargeItemInputParam {
|
|
1008
|
+
comment?: string;
|
|
1009
|
+
subscription_id?: string;
|
|
1010
|
+
item_price?: ItemPriceAddChargeItemInputParam;
|
|
1011
|
+
item_tiers?: ItemTiersAddChargeItemInputParam[];
|
|
1012
|
+
}
|
|
1013
|
+
export interface CloseInputParam {
|
|
1014
|
+
comment?: string;
|
|
1015
|
+
invoice_note?: string;
|
|
1016
|
+
remove_general_note?: boolean;
|
|
1017
|
+
invoice_date?: number;
|
|
1018
|
+
notes_to_remove?: NotesToRemoveCloseInputParam[];
|
|
1019
|
+
}
|
|
1020
|
+
export interface CollectPaymentInputParam {
|
|
1021
|
+
amount?: number;
|
|
1022
|
+
authorization_transaction_id?: string;
|
|
1023
|
+
payment_source_id?: string;
|
|
1024
|
+
comment?: string;
|
|
1025
|
+
payment_initiator?: PaymentInitiatorEnum;
|
|
1026
|
+
}
|
|
1027
|
+
export interface RecordPaymentInputParam {
|
|
1028
|
+
comment?: string;
|
|
1029
|
+
transaction?: TransactionRecordPaymentInputParam;
|
|
1030
|
+
}
|
|
1031
|
+
export interface RecordTaxWithheldInputParam {
|
|
1032
|
+
tax_withheld?: TaxWithheldRecordTaxWithheldInputParam;
|
|
1033
|
+
}
|
|
1034
|
+
export interface RemoveTaxWithheldInputParam {
|
|
1035
|
+
tax_withheld?: TaxWithheldRemoveTaxWithheldInputParam;
|
|
1036
|
+
}
|
|
1037
|
+
export interface RefundInputParam {
|
|
1038
|
+
refund_amount?: number;
|
|
1039
|
+
comment?: string;
|
|
1040
|
+
customer_notes?: string;
|
|
1041
|
+
credit_note?: CreditNoteRefundInputParam;
|
|
1042
|
+
}
|
|
1043
|
+
export interface RecordRefundInputParam {
|
|
1044
|
+
comment?: string;
|
|
1045
|
+
customer_notes?: string;
|
|
1046
|
+
transaction?: TransactionRecordRefundInputParam;
|
|
1047
|
+
credit_note?: CreditNoteRecordRefundInputParam;
|
|
1048
|
+
}
|
|
1049
|
+
export interface RemovePaymentInputParam {
|
|
1050
|
+
transaction?: TransactionRemovePaymentInputParam;
|
|
1051
|
+
}
|
|
1052
|
+
export interface RemoveCreditNoteInputParam {
|
|
1053
|
+
credit_note?: CreditNoteRemoveCreditNoteInputParam;
|
|
1054
|
+
}
|
|
1055
|
+
export interface VoidInvoiceInputParam {
|
|
1056
|
+
comment?: string;
|
|
1057
|
+
void_reason_code?: string;
|
|
1058
|
+
}
|
|
1059
|
+
export interface WriteOffInputParam {
|
|
1060
|
+
comment?: string;
|
|
1061
|
+
}
|
|
1062
|
+
export interface DeleteInputParam {
|
|
1063
|
+
comment?: string;
|
|
1064
|
+
}
|
|
1065
|
+
export interface UpdateDetailsInputParam {
|
|
1066
|
+
vat_number?: string;
|
|
1067
|
+
vat_number_prefix?: string;
|
|
1068
|
+
po_number?: string;
|
|
1069
|
+
comment?: string;
|
|
1070
|
+
billing_address?: BillingAddressUpdateDetailsInputParam;
|
|
1071
|
+
shipping_address?: ShippingAddressUpdateDetailsInputParam;
|
|
1072
|
+
statement_descriptor?: StatementDescriptorUpdateDetailsInputParam;
|
|
1073
|
+
}
|
|
1074
|
+
export interface ApplyPaymentScheduleSchemeInputParam {
|
|
1075
|
+
scheme_id: string;
|
|
1076
|
+
amount?: number;
|
|
1077
|
+
}
|
|
1078
|
+
export interface StatementDescriptorCreateInputParam {
|
|
1079
|
+
descriptor?: string;
|
|
1080
|
+
}
|
|
1081
|
+
export interface ShippingAddressCreateInputParam {
|
|
1082
|
+
first_name?: string;
|
|
1083
|
+
last_name?: string;
|
|
1084
|
+
email?: string;
|
|
1085
|
+
company?: string;
|
|
1086
|
+
phone?: string;
|
|
1087
|
+
line1?: string;
|
|
1088
|
+
line2?: string;
|
|
1089
|
+
line3?: string;
|
|
1090
|
+
city?: string;
|
|
1091
|
+
state_code?: string;
|
|
1092
|
+
state?: string;
|
|
1093
|
+
zip?: string;
|
|
1094
|
+
country?: string;
|
|
1095
|
+
validation_status?: ValidationStatusEnum;
|
|
1096
|
+
}
|
|
1097
|
+
export interface PaymentMethodCreateInputParam {
|
|
1098
|
+
type?: TypeEnum;
|
|
1099
|
+
/**
|
|
1100
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1101
|
+
*/
|
|
1102
|
+
gateway?: GatewayEnum;
|
|
1103
|
+
gateway_account_id?: string;
|
|
1104
|
+
reference_id?: string;
|
|
1105
|
+
tmp_token?: string;
|
|
1106
|
+
issuing_country?: string;
|
|
1107
|
+
additional_information?: any;
|
|
1108
|
+
}
|
|
1109
|
+
export interface BankAccountCreateInputParam {
|
|
1110
|
+
gateway_account_id?: string;
|
|
1111
|
+
iban?: string;
|
|
1112
|
+
first_name?: string;
|
|
1113
|
+
last_name?: string;
|
|
1114
|
+
company?: string;
|
|
1115
|
+
email?: string;
|
|
1116
|
+
phone?: string;
|
|
1117
|
+
bank_name?: string;
|
|
1118
|
+
account_number?: string;
|
|
1119
|
+
routing_number?: string;
|
|
1120
|
+
bank_code?: string;
|
|
1121
|
+
account_type?: AccountTypeEnum;
|
|
1122
|
+
account_holder_type?: AccountHolderTypeEnum;
|
|
1123
|
+
echeck_type?: EcheckTypeEnum;
|
|
1124
|
+
issuing_country?: string;
|
|
1125
|
+
swedish_identity_number?: string;
|
|
1126
|
+
billing_address?: any;
|
|
1127
|
+
}
|
|
1128
|
+
export interface PaymentIntentCreateInputParam {
|
|
1129
|
+
id?: string;
|
|
1130
|
+
gateway_account_id?: string;
|
|
1131
|
+
gw_token?: string;
|
|
1132
|
+
payment_method_type?:
|
|
1133
|
+
| 'card'
|
|
1134
|
+
| 'ideal'
|
|
1135
|
+
| 'sofort'
|
|
1136
|
+
| 'bancontact'
|
|
1137
|
+
| 'google_pay'
|
|
1138
|
+
| 'dotpay'
|
|
1139
|
+
| 'giropay'
|
|
1140
|
+
| 'apple_pay'
|
|
1141
|
+
| 'upi'
|
|
1142
|
+
| 'netbanking_emandates'
|
|
1143
|
+
| 'paypal_express_checkout'
|
|
1144
|
+
| 'direct_debit'
|
|
1145
|
+
| 'boleto'
|
|
1146
|
+
| 'venmo'
|
|
1147
|
+
| 'amazon_payments'
|
|
1148
|
+
| 'pay_to'
|
|
1149
|
+
| 'faster_payments'
|
|
1150
|
+
| 'sepa_instant_transfer'
|
|
1151
|
+
| 'klarna_pay_now'
|
|
1152
|
+
| 'online_banking_poland';
|
|
1153
|
+
reference_id?: string;
|
|
1154
|
+
/**
|
|
1155
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1156
|
+
*/
|
|
1157
|
+
gw_payment_method_id?: string;
|
|
1158
|
+
additional_information?: any;
|
|
1159
|
+
}
|
|
1160
|
+
export interface CardCreateInputParam {
|
|
1161
|
+
/**
|
|
1162
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1163
|
+
*/
|
|
1164
|
+
gateway?: GatewayEnum;
|
|
1165
|
+
gateway_account_id?: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1168
|
+
*/
|
|
1169
|
+
tmp_token?: string;
|
|
1170
|
+
first_name?: string;
|
|
1171
|
+
last_name?: string;
|
|
1172
|
+
number?: string;
|
|
1173
|
+
expiry_month?: number;
|
|
1174
|
+
expiry_year?: number;
|
|
1175
|
+
cvv?: string;
|
|
1176
|
+
billing_addr1?: string;
|
|
1177
|
+
billing_addr2?: string;
|
|
1178
|
+
billing_city?: string;
|
|
1179
|
+
billing_state_code?: string;
|
|
1180
|
+
billing_state?: string;
|
|
1181
|
+
billing_zip?: string;
|
|
1182
|
+
billing_country?: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1185
|
+
*/
|
|
1186
|
+
ip_address?: string;
|
|
1187
|
+
additional_information?: any;
|
|
1188
|
+
}
|
|
1189
|
+
|
|
1190
|
+
export interface ChargesCreateInputParam {
|
|
1191
|
+
amount?: number;
|
|
1192
|
+
amount_in_decimal?: string;
|
|
1193
|
+
description?: string;
|
|
1194
|
+
taxable?: boolean;
|
|
1195
|
+
tax_profile_id?: string;
|
|
1196
|
+
avalara_tax_code?: string;
|
|
1197
|
+
hsn_code?: string;
|
|
1198
|
+
taxjar_product_code?: string;
|
|
1199
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
1200
|
+
avalara_transaction_type?: number;
|
|
1201
|
+
avalara_service_type?: number;
|
|
1202
|
+
date_from?: number;
|
|
1203
|
+
date_to?: number;
|
|
1204
|
+
}
|
|
1205
|
+
export interface AddonsCreateInputParam {
|
|
1206
|
+
id?: string;
|
|
1207
|
+
quantity?: number;
|
|
1208
|
+
unit_price?: number;
|
|
1209
|
+
quantity_in_decimal?: string;
|
|
1210
|
+
unit_price_in_decimal?: string;
|
|
1211
|
+
date_from?: number;
|
|
1212
|
+
date_to?: number;
|
|
1213
|
+
}
|
|
1214
|
+
export interface TaxProvidersFieldsCreateInputParam {
|
|
1215
|
+
provider_name?: string;
|
|
1216
|
+
field_id?: string;
|
|
1217
|
+
field_value?: string;
|
|
1218
|
+
}
|
|
1219
|
+
export interface NotesToRemoveCreateInputParam {
|
|
1220
|
+
entity_type?: EntityTypeEnum;
|
|
1221
|
+
entity_id?: string;
|
|
1222
|
+
}
|
|
1223
|
+
export interface StatementDescriptorCreateForChargeItemsAndChargesInputParam {
|
|
1224
|
+
descriptor?: string;
|
|
1225
|
+
}
|
|
1226
|
+
export interface ShippingAddressCreateForChargeItemsAndChargesInputParam {
|
|
1227
|
+
first_name?: string;
|
|
1228
|
+
last_name?: string;
|
|
1229
|
+
email?: string;
|
|
1230
|
+
company?: string;
|
|
1231
|
+
phone?: string;
|
|
1232
|
+
line1?: string;
|
|
1233
|
+
line2?: string;
|
|
1234
|
+
line3?: string;
|
|
1235
|
+
city?: string;
|
|
1236
|
+
state_code?: string;
|
|
1237
|
+
state?: string;
|
|
1238
|
+
zip?: string;
|
|
1239
|
+
country?: string;
|
|
1240
|
+
validation_status?: ValidationStatusEnum;
|
|
1241
|
+
}
|
|
1242
|
+
export interface PaymentMethodCreateForChargeItemsAndChargesInputParam {
|
|
1243
|
+
type?: TypeEnum;
|
|
1244
|
+
/**
|
|
1245
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1246
|
+
*/
|
|
1247
|
+
gateway?: GatewayEnum;
|
|
1248
|
+
gateway_account_id?: string;
|
|
1249
|
+
reference_id?: string;
|
|
1250
|
+
tmp_token?: string;
|
|
1251
|
+
issuing_country?: string;
|
|
1252
|
+
additional_information?: any;
|
|
1253
|
+
}
|
|
1254
|
+
export interface BankAccountCreateForChargeItemsAndChargesInputParam {
|
|
1255
|
+
gateway_account_id?: string;
|
|
1256
|
+
iban?: string;
|
|
1257
|
+
first_name?: string;
|
|
1258
|
+
last_name?: string;
|
|
1259
|
+
company?: string;
|
|
1260
|
+
email?: string;
|
|
1261
|
+
phone?: string;
|
|
1262
|
+
bank_name?: string;
|
|
1263
|
+
account_number?: string;
|
|
1264
|
+
routing_number?: string;
|
|
1265
|
+
bank_code?: string;
|
|
1266
|
+
account_type?: AccountTypeEnum;
|
|
1267
|
+
account_holder_type?: AccountHolderTypeEnum;
|
|
1268
|
+
echeck_type?: EcheckTypeEnum;
|
|
1269
|
+
issuing_country?: string;
|
|
1270
|
+
swedish_identity_number?: string;
|
|
1271
|
+
billing_address?: any;
|
|
1272
|
+
}
|
|
1273
|
+
export interface PaymentIntentCreateForChargeItemsAndChargesInputParam {
|
|
1274
|
+
id?: string;
|
|
1275
|
+
gateway_account_id?: string;
|
|
1276
|
+
gw_token?: string;
|
|
1277
|
+
payment_method_type?:
|
|
1278
|
+
| 'card'
|
|
1279
|
+
| 'ideal'
|
|
1280
|
+
| 'sofort'
|
|
1281
|
+
| 'bancontact'
|
|
1282
|
+
| 'google_pay'
|
|
1283
|
+
| 'dotpay'
|
|
1284
|
+
| 'giropay'
|
|
1285
|
+
| 'apple_pay'
|
|
1286
|
+
| 'upi'
|
|
1287
|
+
| 'netbanking_emandates'
|
|
1288
|
+
| 'paypal_express_checkout'
|
|
1289
|
+
| 'direct_debit'
|
|
1290
|
+
| 'boleto'
|
|
1291
|
+
| 'venmo'
|
|
1292
|
+
| 'amazon_payments'
|
|
1293
|
+
| 'pay_to'
|
|
1294
|
+
| 'faster_payments'
|
|
1295
|
+
| 'sepa_instant_transfer'
|
|
1296
|
+
| 'klarna_pay_now'
|
|
1297
|
+
| 'online_banking_poland';
|
|
1298
|
+
reference_id?: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1301
|
+
*/
|
|
1302
|
+
gw_payment_method_id?: string;
|
|
1303
|
+
additional_information?: any;
|
|
1304
|
+
}
|
|
1305
|
+
export interface CardCreateForChargeItemsAndChargesInputParam {
|
|
1306
|
+
/**
|
|
1307
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1308
|
+
*/
|
|
1309
|
+
gateway?: GatewayEnum;
|
|
1310
|
+
gateway_account_id?: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1313
|
+
*/
|
|
1314
|
+
tmp_token?: string;
|
|
1315
|
+
first_name?: string;
|
|
1316
|
+
last_name?: string;
|
|
1317
|
+
number?: string;
|
|
1318
|
+
expiry_month?: number;
|
|
1319
|
+
expiry_year?: number;
|
|
1320
|
+
cvv?: string;
|
|
1321
|
+
billing_addr1?: string;
|
|
1322
|
+
billing_addr2?: string;
|
|
1323
|
+
billing_city?: string;
|
|
1324
|
+
billing_state_code?: string;
|
|
1325
|
+
billing_state?: string;
|
|
1326
|
+
billing_zip?: string;
|
|
1327
|
+
billing_country?: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1330
|
+
*/
|
|
1331
|
+
ip_address?: string;
|
|
1332
|
+
additional_information?: any;
|
|
1333
|
+
}
|
|
1334
|
+
|
|
1335
|
+
export interface ChargesCreateForChargeItemsAndChargesInputParam {
|
|
1336
|
+
amount?: number;
|
|
1337
|
+
amount_in_decimal?: string;
|
|
1338
|
+
description?: string;
|
|
1339
|
+
taxable?: boolean;
|
|
1340
|
+
tax_profile_id?: string;
|
|
1341
|
+
avalara_tax_code?: string;
|
|
1342
|
+
hsn_code?: string;
|
|
1343
|
+
taxjar_product_code?: string;
|
|
1344
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
1345
|
+
avalara_transaction_type?: number;
|
|
1346
|
+
avalara_service_type?: number;
|
|
1347
|
+
date_from?: number;
|
|
1348
|
+
date_to?: number;
|
|
1349
|
+
}
|
|
1350
|
+
export interface DiscountsCreateForChargeItemsAndChargesInputParam {
|
|
1351
|
+
percentage?: number;
|
|
1352
|
+
amount?: number;
|
|
1353
|
+
apply_on: ApplyOnEnum;
|
|
1354
|
+
item_price_id?: string;
|
|
1355
|
+
}
|
|
1356
|
+
export interface ItemTiersCreateForChargeItemsAndChargesInputParam {
|
|
1357
|
+
item_price_id?: string;
|
|
1358
|
+
starting_unit?: number;
|
|
1359
|
+
ending_unit?: number;
|
|
1360
|
+
price?: number;
|
|
1361
|
+
starting_unit_in_decimal?: string;
|
|
1362
|
+
ending_unit_in_decimal?: string;
|
|
1363
|
+
price_in_decimal?: string;
|
|
1364
|
+
}
|
|
1365
|
+
export interface ItemPricesCreateForChargeItemsAndChargesInputParam {
|
|
1366
|
+
item_price_id?: string;
|
|
1367
|
+
quantity?: number;
|
|
1368
|
+
quantity_in_decimal?: string;
|
|
1369
|
+
unit_price?: number;
|
|
1370
|
+
unit_price_in_decimal?: string;
|
|
1371
|
+
date_from?: number;
|
|
1372
|
+
date_to?: number;
|
|
1373
|
+
}
|
|
1374
|
+
export interface TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam {
|
|
1375
|
+
provider_name?: string;
|
|
1376
|
+
field_id?: string;
|
|
1377
|
+
field_value?: string;
|
|
1378
|
+
}
|
|
1379
|
+
export interface NotesToRemoveCreateForChargeItemsAndChargesInputParam {
|
|
1380
|
+
entity_type?: EntityTypeEnum;
|
|
1381
|
+
entity_id?: string;
|
|
1382
|
+
}
|
|
1383
|
+
export interface TaxProvidersFieldsChargeInputParam {
|
|
1384
|
+
provider_name?: string;
|
|
1385
|
+
field_id?: string;
|
|
1386
|
+
field_value?: string;
|
|
1387
|
+
}
|
|
1388
|
+
export interface ItemPriceCreateForChargeItemInputParam {
|
|
1389
|
+
item_price_id: string;
|
|
1390
|
+
quantity?: number;
|
|
1391
|
+
quantity_in_decimal?: string;
|
|
1392
|
+
unit_price?: number;
|
|
1393
|
+
unit_price_in_decimal?: string;
|
|
1394
|
+
date_from?: number;
|
|
1395
|
+
date_to?: number;
|
|
1396
|
+
}
|
|
1397
|
+
|
|
1398
|
+
export interface ItemTiersCreateForChargeItemInputParam {
|
|
1399
|
+
starting_unit?: number;
|
|
1400
|
+
ending_unit?: number;
|
|
1401
|
+
price?: number;
|
|
1402
|
+
starting_unit_in_decimal?: string;
|
|
1403
|
+
ending_unit_in_decimal?: string;
|
|
1404
|
+
price_in_decimal?: string;
|
|
1405
|
+
}
|
|
1406
|
+
export interface BillingAddressImportInvoiceInputParam {
|
|
1407
|
+
first_name?: string;
|
|
1408
|
+
last_name?: string;
|
|
1409
|
+
email?: string;
|
|
1410
|
+
company?: string;
|
|
1411
|
+
phone?: string;
|
|
1412
|
+
line1?: string;
|
|
1413
|
+
line2?: string;
|
|
1414
|
+
line3?: string;
|
|
1415
|
+
city?: string;
|
|
1416
|
+
state_code?: string;
|
|
1417
|
+
state?: string;
|
|
1418
|
+
zip?: string;
|
|
1419
|
+
country?: string;
|
|
1420
|
+
validation_status?: ValidationStatusEnum;
|
|
1421
|
+
}
|
|
1422
|
+
export interface ShippingAddressImportInvoiceInputParam {
|
|
1423
|
+
first_name?: string;
|
|
1424
|
+
last_name?: string;
|
|
1425
|
+
email?: string;
|
|
1426
|
+
company?: string;
|
|
1427
|
+
phone?: string;
|
|
1428
|
+
line1?: string;
|
|
1429
|
+
line2?: string;
|
|
1430
|
+
line3?: string;
|
|
1431
|
+
city?: string;
|
|
1432
|
+
state_code?: string;
|
|
1433
|
+
state?: string;
|
|
1434
|
+
zip?: string;
|
|
1435
|
+
country?: string;
|
|
1436
|
+
validation_status?: ValidationStatusEnum;
|
|
1437
|
+
}
|
|
1438
|
+
export interface CreditNoteImportInvoiceInputParam {
|
|
1439
|
+
id?: string;
|
|
1440
|
+
}
|
|
1441
|
+
|
|
1442
|
+
export interface PaymentReferenceNumbersImportInvoiceInputParam {
|
|
1443
|
+
id?: string;
|
|
1444
|
+
type: 'kid' | 'ocr' | 'frn' | 'fik' | 'swiss_reference';
|
|
1445
|
+
number: string;
|
|
1446
|
+
}
|
|
1447
|
+
export interface NotesImportInvoiceInputParam {
|
|
1448
|
+
entity_type?:
|
|
1449
|
+
| 'coupon'
|
|
1450
|
+
| 'plan_item_price'
|
|
1451
|
+
| 'addon_item_price'
|
|
1452
|
+
| 'charge_item_price';
|
|
1453
|
+
entity_id?: string;
|
|
1454
|
+
note?: string;
|
|
1455
|
+
}
|
|
1456
|
+
export interface DiscountsImportInvoiceInputParam {
|
|
1457
|
+
entity_type:
|
|
1458
|
+
| 'item_level_coupon'
|
|
1459
|
+
| 'document_level_coupon'
|
|
1460
|
+
| 'promotional_credits'
|
|
1461
|
+
| 'item_level_discount'
|
|
1462
|
+
| 'document_level_discount';
|
|
1463
|
+
entity_id?: string;
|
|
1464
|
+
description?: string;
|
|
1465
|
+
amount: number;
|
|
1466
|
+
}
|
|
1467
|
+
export interface PaymentsImportInvoiceInputParam {
|
|
1468
|
+
amount: number;
|
|
1469
|
+
payment_method: PaymentMethodEnum;
|
|
1470
|
+
date?: number;
|
|
1471
|
+
reference_number?: string;
|
|
1472
|
+
}
|
|
1473
|
+
export interface TaxesImportInvoiceInputParam {
|
|
1474
|
+
name: string;
|
|
1475
|
+
rate: number;
|
|
1476
|
+
amount?: number;
|
|
1477
|
+
description?: string;
|
|
1478
|
+
juris_type?:
|
|
1479
|
+
| 'country'
|
|
1480
|
+
| 'federal'
|
|
1481
|
+
| 'state'
|
|
1482
|
+
| 'county'
|
|
1483
|
+
| 'city'
|
|
1484
|
+
| 'special'
|
|
1485
|
+
| 'unincorporated'
|
|
1486
|
+
| 'other';
|
|
1487
|
+
juris_name?: string;
|
|
1488
|
+
juris_code?: string;
|
|
1489
|
+
}
|
|
1490
|
+
export interface LineItemTiersImportInvoiceInputParam {
|
|
1491
|
+
line_item_id: string;
|
|
1492
|
+
starting_unit?: number;
|
|
1493
|
+
ending_unit?: number;
|
|
1494
|
+
quantity_used?: number;
|
|
1495
|
+
unit_amount?: number;
|
|
1496
|
+
starting_unit_in_decimal?: string;
|
|
1497
|
+
ending_unit_in_decimal?: string;
|
|
1498
|
+
quantity_used_in_decimal?: string;
|
|
1499
|
+
unit_amount_in_decimal?: string;
|
|
1500
|
+
}
|
|
1501
|
+
export interface LineItemsImportInvoiceInputParam {
|
|
1502
|
+
id?: string;
|
|
1503
|
+
date_from?: number;
|
|
1504
|
+
date_to?: number;
|
|
1505
|
+
subscription_id?: string;
|
|
1506
|
+
description: string;
|
|
1507
|
+
unit_amount?: number;
|
|
1508
|
+
quantity?: number;
|
|
1509
|
+
amount?: number;
|
|
1510
|
+
unit_amount_in_decimal?: string;
|
|
1511
|
+
quantity_in_decimal?: string;
|
|
1512
|
+
amount_in_decimal?: string;
|
|
1513
|
+
entity_type?:
|
|
1514
|
+
| 'adhoc'
|
|
1515
|
+
| 'plan_item_price'
|
|
1516
|
+
| 'addon_item_price'
|
|
1517
|
+
| 'charge_item_price';
|
|
1518
|
+
entity_id?: string;
|
|
1519
|
+
item_level_discount1_entity_id?: string;
|
|
1520
|
+
item_level_discount1_amount?: number;
|
|
1521
|
+
item_level_discount2_entity_id?: string;
|
|
1522
|
+
item_level_discount2_amount?: number;
|
|
1523
|
+
tax1_name?: string;
|
|
1524
|
+
tax1_amount?: number;
|
|
1525
|
+
tax2_name?: string;
|
|
1526
|
+
tax2_amount?: number;
|
|
1527
|
+
tax3_name?: string;
|
|
1528
|
+
tax3_amount?: number;
|
|
1529
|
+
tax4_name?: string;
|
|
1530
|
+
tax4_amount?: number;
|
|
1531
|
+
tax5_name?: string;
|
|
1532
|
+
tax5_amount?: number;
|
|
1533
|
+
tax6_name?: string;
|
|
1534
|
+
tax6_amount?: number;
|
|
1535
|
+
tax7_name?: string;
|
|
1536
|
+
tax7_amount?: number;
|
|
1537
|
+
tax8_name?: string;
|
|
1538
|
+
tax8_amount?: number;
|
|
1539
|
+
tax9_name?: string;
|
|
1540
|
+
tax9_amount?: number;
|
|
1541
|
+
tax10_name?: string;
|
|
1542
|
+
tax10_amount?: number;
|
|
1543
|
+
}
|
|
1544
|
+
export interface TransactionsApplyPaymentsInputParam {
|
|
1545
|
+
id?: string;
|
|
1546
|
+
amount?: number;
|
|
1547
|
+
}
|
|
1548
|
+
export interface LineItemsDeleteLineItemsInputParam {
|
|
1549
|
+
id?: string;
|
|
1550
|
+
}
|
|
1551
|
+
export interface CreditNotesApplyCreditsInputParam {
|
|
1552
|
+
id?: string;
|
|
1553
|
+
}
|
|
1554
|
+
export interface EinvoiceInvoiceListInputParam {
|
|
1555
|
+
status?: filter.Enum;
|
|
1556
|
+
}
|
|
1557
|
+
|
|
1558
|
+
export interface PaymentReferenceNumberInvoiceListPaymentReferenceNumbersInputParam {
|
|
1559
|
+
number?: filter.String;
|
|
1560
|
+
}
|
|
1561
|
+
|
|
1562
|
+
export interface LineItemAddChargeInputParam {
|
|
1563
|
+
date_from?: number;
|
|
1564
|
+
date_to?: number;
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
export interface LineItemAddAddonChargeInputParam {
|
|
1568
|
+
date_from?: number;
|
|
1569
|
+
date_to?: number;
|
|
1570
|
+
}
|
|
1571
|
+
|
|
1572
|
+
export interface ItemPriceAddChargeItemInputParam {
|
|
1573
|
+
item_price_id: string;
|
|
1574
|
+
quantity?: number;
|
|
1575
|
+
quantity_in_decimal?: string;
|
|
1576
|
+
unit_price?: number;
|
|
1577
|
+
unit_price_in_decimal?: string;
|
|
1578
|
+
date_from?: number;
|
|
1579
|
+
date_to?: number;
|
|
1580
|
+
}
|
|
1581
|
+
|
|
1582
|
+
export interface ItemTiersAddChargeItemInputParam {
|
|
1583
|
+
starting_unit?: number;
|
|
1584
|
+
ending_unit?: number;
|
|
1585
|
+
price?: number;
|
|
1586
|
+
starting_unit_in_decimal?: string;
|
|
1587
|
+
ending_unit_in_decimal?: string;
|
|
1588
|
+
price_in_decimal?: string;
|
|
1589
|
+
}
|
|
1590
|
+
export interface NotesToRemoveCloseInputParam {
|
|
1591
|
+
entity_type?: EntityTypeEnum;
|
|
1592
|
+
entity_id?: string;
|
|
1593
|
+
}
|
|
1594
|
+
export interface TransactionRecordPaymentInputParam {
|
|
1595
|
+
amount?: number;
|
|
1596
|
+
payment_method: PaymentMethodEnum;
|
|
1597
|
+
reference_number?: string;
|
|
1598
|
+
custom_payment_method_id?: string;
|
|
1599
|
+
id_at_gateway?: string;
|
|
1600
|
+
status?: 'success' | 'failure';
|
|
1601
|
+
date?: number;
|
|
1602
|
+
error_code?: string;
|
|
1603
|
+
error_text?: string;
|
|
1604
|
+
}
|
|
1605
|
+
|
|
1606
|
+
export interface TaxWithheldRecordTaxWithheldInputParam {
|
|
1607
|
+
amount: number;
|
|
1608
|
+
reference_number?: string;
|
|
1609
|
+
date?: number;
|
|
1610
|
+
description?: string;
|
|
1611
|
+
}
|
|
1612
|
+
|
|
1613
|
+
export interface TaxWithheldRemoveTaxWithheldInputParam {
|
|
1614
|
+
id: string;
|
|
1615
|
+
}
|
|
1616
|
+
|
|
1617
|
+
export interface CreditNoteRefundInputParam {
|
|
1618
|
+
reason_code?:
|
|
1619
|
+
| 'product_unsatisfactory'
|
|
1620
|
+
| 'service_unsatisfactory'
|
|
1621
|
+
| 'order_change'
|
|
1622
|
+
| 'order_cancellation'
|
|
1623
|
+
| 'waiver'
|
|
1624
|
+
| 'other';
|
|
1625
|
+
create_reason_code?: string;
|
|
1626
|
+
}
|
|
1627
|
+
|
|
1628
|
+
export interface TransactionRecordRefundInputParam {
|
|
1629
|
+
amount?: number;
|
|
1630
|
+
payment_method: PaymentMethodEnum;
|
|
1631
|
+
reference_number?: string;
|
|
1632
|
+
custom_payment_method_id?: string;
|
|
1633
|
+
date: number;
|
|
1634
|
+
}
|
|
1635
|
+
export interface CreditNoteRecordRefundInputParam {
|
|
1636
|
+
reason_code?:
|
|
1637
|
+
| 'chargeback'
|
|
1638
|
+
| 'product_unsatisfactory'
|
|
1639
|
+
| 'service_unsatisfactory'
|
|
1640
|
+
| 'order_change'
|
|
1641
|
+
| 'order_cancellation'
|
|
1642
|
+
| 'waiver'
|
|
1643
|
+
| 'other';
|
|
1644
|
+
create_reason_code?: string;
|
|
1645
|
+
}
|
|
1646
|
+
|
|
1647
|
+
export interface TransactionRemovePaymentInputParam {
|
|
1648
|
+
id: string;
|
|
1649
|
+
}
|
|
1650
|
+
|
|
1651
|
+
export interface CreditNoteRemoveCreditNoteInputParam {
|
|
1652
|
+
id: string;
|
|
1653
|
+
}
|
|
1654
|
+
|
|
1655
|
+
export interface BillingAddressUpdateDetailsInputParam {
|
|
1656
|
+
first_name?: string;
|
|
1657
|
+
last_name?: string;
|
|
1658
|
+
email?: string;
|
|
1659
|
+
company?: string;
|
|
1660
|
+
phone?: string;
|
|
1661
|
+
line1?: string;
|
|
1662
|
+
line2?: string;
|
|
1663
|
+
line3?: string;
|
|
1664
|
+
city?: string;
|
|
1665
|
+
state_code?: string;
|
|
1666
|
+
state?: string;
|
|
1667
|
+
zip?: string;
|
|
1668
|
+
country?: string;
|
|
1669
|
+
validation_status?: ValidationStatusEnum;
|
|
1670
|
+
}
|
|
1671
|
+
export interface StatementDescriptorUpdateDetailsInputParam {
|
|
1672
|
+
descriptor?: string;
|
|
1673
|
+
}
|
|
1674
|
+
export interface ShippingAddressUpdateDetailsInputParam {
|
|
1675
|
+
first_name?: string;
|
|
1676
|
+
last_name?: string;
|
|
1677
|
+
email?: string;
|
|
1678
|
+
company?: string;
|
|
1679
|
+
phone?: string;
|
|
1680
|
+
line1?: string;
|
|
1681
|
+
line2?: string;
|
|
1682
|
+
line3?: string;
|
|
1683
|
+
city?: string;
|
|
1684
|
+
state_code?: string;
|
|
1685
|
+
state?: string;
|
|
1686
|
+
zip?: string;
|
|
1687
|
+
country?: string;
|
|
1688
|
+
validation_status?: ValidationStatusEnum;
|
|
1689
|
+
}
|
|
1690
|
+
}
|
|
1691
|
+
}
|