orb-billing 4.74.0 → 5.0.0
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 +23 -0
- package/index.d.mts +148 -14
- package/index.d.ts +148 -14
- package/index.d.ts.map +1 -1
- package/index.js +0 -3
- package/index.js.map +1 -1
- package/index.mjs +3 -6
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/alerts.d.ts +20 -88
- package/resources/alerts.d.ts.map +1 -1
- package/resources/alerts.js.map +1 -1
- package/resources/alerts.mjs.map +1 -1
- package/resources/beta/beta.d.ts +9 -7313
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/external-plan-id.d.ts +7 -7074
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/beta/external-plan-id.js.map +1 -1
- package/resources/beta/external-plan-id.mjs.map +1 -1
- package/resources/credit-notes.d.ts +9 -163
- package/resources/credit-notes.d.ts.map +1 -1
- package/resources/credit-notes.js +3 -6
- package/resources/credit-notes.js.map +1 -1
- package/resources/credit-notes.mjs +2 -4
- package/resources/credit-notes.mjs.map +1 -1
- package/resources/customers/balance-transactions.d.ts +5 -32
- package/resources/customers/balance-transactions.d.ts.map +1 -1
- package/resources/customers/balance-transactions.js.map +1 -1
- package/resources/customers/balance-transactions.mjs.map +1 -1
- package/resources/customers/costs.d.ts +3 -81
- package/resources/customers/costs.d.ts.map +1 -1
- package/resources/customers/credits/credits.d.ts +4 -4
- package/resources/customers/credits/credits.d.ts.map +1 -1
- package/resources/customers/credits/credits.js.map +1 -1
- package/resources/customers/credits/credits.mjs.map +1 -1
- package/resources/customers/credits/index.d.ts +2 -2
- package/resources/customers/credits/index.d.ts.map +1 -1
- package/resources/customers/credits/index.js.map +1 -1
- package/resources/customers/credits/index.mjs.map +1 -1
- package/resources/customers/credits/ledger.d.ts +171 -962
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/credits/top-ups.d.ts +29 -121
- package/resources/customers/credits/top-ups.d.ts.map +1 -1
- package/resources/customers/credits/top-ups.js.map +1 -1
- package/resources/customers/credits/top-ups.mjs.map +1 -1
- package/resources/customers/customers.d.ts +72 -678
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/customers/index.d.ts +1 -1
- package/resources/customers/index.d.ts.map +1 -1
- package/resources/customers/index.js.map +1 -1
- package/resources/customers/index.mjs.map +1 -1
- package/resources/index.d.ts +7 -7
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -3
- package/resources/index.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +6 -395
- package/resources/invoice-line-items.d.ts.map +1 -1
- package/resources/invoice-line-items.js.map +1 -1
- package/resources/invoice-line-items.mjs.map +1 -1
- package/resources/invoices.d.ts +30 -1700
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +3 -6
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +2 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/plans/plans.d.ts +7 -3801
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/external-price-id.d.ts +3 -3
- package/resources/prices/external-price-id.d.ts.map +1 -1
- package/resources/prices/index.d.ts +1 -1
- package/resources/prices/index.d.ts.map +1 -1
- package/resources/prices/index.js +1 -2
- package/resources/prices/index.js.map +1 -1
- package/resources/prices/index.mjs +1 -1
- package/resources/prices/index.mjs.map +1 -1
- package/resources/prices/prices.d.ts +346 -9372
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js +39 -20
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs +38 -18
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/shared.d.ts +7269 -9
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.js +11 -0
- package/resources/shared.js.map +1 -1
- package/resources/shared.mjs +7 -1
- package/resources/shared.mjs.map +1 -1
- package/resources/subscription-changes.d.ts +138 -2158
- package/resources/subscription-changes.d.ts.map +1 -1
- package/resources/subscription-changes.js.map +1 -1
- package/resources/subscription-changes.mjs.map +1 -1
- package/resources/subscriptions.d.ts +2639 -27234
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/index.ts +219 -42
- package/src/resources/alerts.ts +20 -94
- package/src/resources/beta/beta.ts +124 -8892
- package/src/resources/beta/external-plan-id.ts +118 -8593
- package/src/resources/credit-notes.ts +10 -217
- package/src/resources/customers/balance-transactions.ts +5 -36
- package/src/resources/customers/costs.ts +3 -101
- package/src/resources/customers/credits/credits.ts +18 -0
- package/src/resources/customers/credits/index.ts +9 -0
- package/src/resources/customers/credits/ledger.ts +212 -1435
- package/src/resources/customers/credits/top-ups.ts +33 -136
- package/src/resources/customers/customers.ts +162 -1454
- package/src/resources/customers/index.ts +8 -0
- package/src/resources/index.ts +42 -22
- package/src/resources/invoice-line-items.ts +10 -501
- package/src/resources/invoices.ts +60 -2394
- package/src/resources/plans/plans.ts +38 -4588
- package/src/resources/prices/external-price-id.ts +3 -3
- package/src/resources/prices/index.ts +2 -2
- package/src/resources/prices/prices.ts +500 -11810
- package/src/resources/shared.ts +9582 -22
- package/src/resources/subscription-changes.ts +171 -2670
- package/src/resources/subscriptions.ts +3162 -32900
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../resource.js";
|
|
2
2
|
import * as Core from "../../core.js";
|
|
3
|
+
import * as Shared from "../shared.js";
|
|
3
4
|
import * as BalanceTransactionsAPI from "./balance-transactions.js";
|
|
4
5
|
import { BalanceTransactionCreateParams, BalanceTransactionCreateResponse, BalanceTransactionListParams, BalanceTransactionListResponse, BalanceTransactionListResponsesPage, BalanceTransactions } from "./balance-transactions.js";
|
|
5
6
|
import * as CostsAPI from "./costs.js";
|
|
@@ -104,6 +105,18 @@ export declare class Customers extends APIResource {
|
|
|
104
105
|
}
|
|
105
106
|
export declare class CustomersPage extends Page<Customer> {
|
|
106
107
|
}
|
|
108
|
+
export interface AccountingProviderConfig {
|
|
109
|
+
external_provider_id: string;
|
|
110
|
+
provider_type: string;
|
|
111
|
+
}
|
|
112
|
+
export interface AddressInput {
|
|
113
|
+
city?: string | null;
|
|
114
|
+
country?: string | null;
|
|
115
|
+
line1?: string | null;
|
|
116
|
+
line2?: string | null;
|
|
117
|
+
postal_code?: string | null;
|
|
118
|
+
state?: string | null;
|
|
119
|
+
}
|
|
107
120
|
/**
|
|
108
121
|
* A customer is a buyer of your products, and the other party to the billing
|
|
109
122
|
* relationship.
|
|
@@ -132,7 +145,7 @@ export interface Customer {
|
|
|
132
145
|
* The customer's current balance in their currency.
|
|
133
146
|
*/
|
|
134
147
|
balance: string;
|
|
135
|
-
billing_address:
|
|
148
|
+
billing_address: Shared.Address | null;
|
|
136
149
|
created_at: string;
|
|
137
150
|
currency: string | null;
|
|
138
151
|
/**
|
|
@@ -176,7 +189,7 @@ export interface Customer {
|
|
|
176
189
|
*/
|
|
177
190
|
payment_provider_id: string | null;
|
|
178
191
|
portal_url: string | null;
|
|
179
|
-
shipping_address:
|
|
192
|
+
shipping_address: Shared.Address | null;
|
|
180
193
|
/**
|
|
181
194
|
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
182
195
|
* added to the headers of invoices.
|
|
@@ -284,7 +297,7 @@ export interface Customer {
|
|
|
284
297
|
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
285
298
|
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
286
299
|
*/
|
|
287
|
-
tax_id:
|
|
300
|
+
tax_id: Shared.CustomerTaxID | null;
|
|
288
301
|
/**
|
|
289
302
|
* A timezone identifier from the IANA timezone database, such as
|
|
290
303
|
* "America/Los_Angeles". This "defaults to your account's timezone if not set.
|
|
@@ -295,150 +308,12 @@ export interface Customer {
|
|
|
295
308
|
reporting_configuration?: Customer.ReportingConfiguration | null;
|
|
296
309
|
}
|
|
297
310
|
export declare namespace Customer {
|
|
298
|
-
interface BillingAddress {
|
|
299
|
-
city: string | null;
|
|
300
|
-
country: string | null;
|
|
301
|
-
line1: string | null;
|
|
302
|
-
line2: string | null;
|
|
303
|
-
postal_code: string | null;
|
|
304
|
-
state: string | null;
|
|
305
|
-
}
|
|
306
311
|
/**
|
|
307
312
|
* The hierarchical relationships for this customer.
|
|
308
313
|
*/
|
|
309
314
|
interface Hierarchy {
|
|
310
|
-
children: Array<
|
|
311
|
-
parent:
|
|
312
|
-
}
|
|
313
|
-
namespace Hierarchy {
|
|
314
|
-
interface Child {
|
|
315
|
-
id: string;
|
|
316
|
-
external_customer_id: string | null;
|
|
317
|
-
}
|
|
318
|
-
interface Parent {
|
|
319
|
-
id: string;
|
|
320
|
-
external_customer_id: string | null;
|
|
321
|
-
}
|
|
322
|
-
}
|
|
323
|
-
interface ShippingAddress {
|
|
324
|
-
city: string | null;
|
|
325
|
-
country: string | null;
|
|
326
|
-
line1: string | null;
|
|
327
|
-
line2: string | null;
|
|
328
|
-
postal_code: string | null;
|
|
329
|
-
state: string | null;
|
|
330
|
-
}
|
|
331
|
-
/**
|
|
332
|
-
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
333
|
-
* added to the headers of invoices.
|
|
334
|
-
*
|
|
335
|
-
* ### Supported Tax ID Countries and Types
|
|
336
|
-
*
|
|
337
|
-
* | Country | Type | Description |
|
|
338
|
-
* | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
339
|
-
* | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
340
|
-
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
341
|
-
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
342
|
-
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
343
|
-
* | Austria | `eu_vat` | European VAT Number |
|
|
344
|
-
* | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
345
|
-
* | Belgium | `eu_vat` | European VAT Number |
|
|
346
|
-
* | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
347
|
-
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
348
|
-
* | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
349
|
-
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
350
|
-
* | Bulgaria | `eu_vat` | European VAT Number |
|
|
351
|
-
* | Canada | `ca_bn` | Canadian BN |
|
|
352
|
-
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
353
|
-
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
354
|
-
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
355
|
-
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
356
|
-
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
357
|
-
* | Chile | `cl_tin` | Chilean TIN |
|
|
358
|
-
* | China | `cn_tin` | Chinese Tax ID |
|
|
359
|
-
* | Colombia | `co_nit` | Colombian NIT Number |
|
|
360
|
-
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
361
|
-
* | Croatia | `eu_vat` | European VAT Number |
|
|
362
|
-
* | Cyprus | `eu_vat` | European VAT Number |
|
|
363
|
-
* | Czech Republic | `eu_vat` | European VAT Number |
|
|
364
|
-
* | Denmark | `eu_vat` | European VAT Number |
|
|
365
|
-
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
366
|
-
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
367
|
-
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
368
|
-
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
369
|
-
* | Estonia | `eu_vat` | European VAT Number |
|
|
370
|
-
* | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
371
|
-
* | Finland | `eu_vat` | European VAT Number |
|
|
372
|
-
* | France | `eu_vat` | European VAT Number |
|
|
373
|
-
* | Georgia | `ge_vat` | Georgian VAT |
|
|
374
|
-
* | Germany | `eu_vat` | European VAT Number |
|
|
375
|
-
* | Greece | `eu_vat` | European VAT Number |
|
|
376
|
-
* | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
377
|
-
* | Hungary | `eu_vat` | European VAT Number |
|
|
378
|
-
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
379
|
-
* | Iceland | `is_vat` | Icelandic VAT |
|
|
380
|
-
* | India | `in_gst` | Indian GST Number |
|
|
381
|
-
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
382
|
-
* | Ireland | `eu_vat` | European VAT Number |
|
|
383
|
-
* | Israel | `il_vat` | Israel VAT |
|
|
384
|
-
* | Italy | `eu_vat` | European VAT Number |
|
|
385
|
-
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
386
|
-
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
387
|
-
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
388
|
-
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
389
|
-
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
390
|
-
* | Latvia | `eu_vat` | European VAT Number |
|
|
391
|
-
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
392
|
-
* | Lithuania | `eu_vat` | European VAT Number |
|
|
393
|
-
* | Luxembourg | `eu_vat` | European VAT Number |
|
|
394
|
-
* | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
395
|
-
* | Malaysia | `my_itn` | Malaysian ITN |
|
|
396
|
-
* | Malaysia | `my_sst` | Malaysian SST Number |
|
|
397
|
-
* | Malta | `eu_vat ` | European VAT Number |
|
|
398
|
-
* | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
399
|
-
* | Netherlands | `eu_vat` | European VAT Number |
|
|
400
|
-
* | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
401
|
-
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
402
|
-
* | Norway | `no_vat` | Norwegian VAT Number |
|
|
403
|
-
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
404
|
-
* | Oman | `om_vat` | Omani VAT Number |
|
|
405
|
-
* | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
406
|
-
* | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
407
|
-
* | Poland | `eu_vat` | European VAT Number |
|
|
408
|
-
* | Portugal | `eu_vat` | European VAT Number |
|
|
409
|
-
* | Romania | `eu_vat` | European VAT Number |
|
|
410
|
-
* | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
411
|
-
* | Russia | `ru_inn` | Russian INN |
|
|
412
|
-
* | Russia | `ru_kpp` | Russian KPP |
|
|
413
|
-
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
414
|
-
* | Serbia | `rs_pib` | Serbian PIB Number |
|
|
415
|
-
* | Singapore | `sg_gst` | Singaporean GST |
|
|
416
|
-
* | Singapore | `sg_uen` | Singaporean UEN |
|
|
417
|
-
* | Slovakia | `eu_vat` | European VAT Number |
|
|
418
|
-
* | Slovenia | `eu_vat` | European VAT Number |
|
|
419
|
-
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
420
|
-
* | South Africa | `za_vat` | South African VAT Number |
|
|
421
|
-
* | South Korea | `kr_brn` | Korean BRN |
|
|
422
|
-
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
423
|
-
* | Spain | `eu_vat` | European VAT Number |
|
|
424
|
-
* | Sweden | `eu_vat` | European VAT Number |
|
|
425
|
-
* | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
426
|
-
* | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
427
|
-
* | Thailand | `th_vat` | Thai VAT |
|
|
428
|
-
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
429
|
-
* | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
430
|
-
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
431
|
-
* | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
432
|
-
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
433
|
-
* | United States | `us_ein` | United States EIN |
|
|
434
|
-
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
435
|
-
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
436
|
-
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
437
|
-
*/
|
|
438
|
-
interface TaxID {
|
|
439
|
-
country: 'AD' | 'AE' | 'AR' | 'AT' | 'AU' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'DO' | 'EC' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'KZ' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA';
|
|
440
|
-
type: 'ad_nrt' | 'ae_trn' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'bh_vat' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sv_nit' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'uy_ruc' | 've_rif' | 'vn_tin' | 'za_vat';
|
|
441
|
-
value: string;
|
|
315
|
+
children: Array<Shared.CustomerMinified>;
|
|
316
|
+
parent: Shared.CustomerMinified | null;
|
|
442
317
|
}
|
|
443
318
|
interface AccountingSyncConfiguration {
|
|
444
319
|
accounting_providers: Array<AccountingSyncConfiguration.AccountingProvider>;
|
|
@@ -454,6 +329,38 @@ export declare namespace Customer {
|
|
|
454
329
|
exempt: boolean;
|
|
455
330
|
}
|
|
456
331
|
}
|
|
332
|
+
export interface CustomerHierarchyConfig {
|
|
333
|
+
/**
|
|
334
|
+
* A list of child customer IDs to add to the hierarchy. The desired child
|
|
335
|
+
* customers must not already be part of another hierarchy.
|
|
336
|
+
*/
|
|
337
|
+
child_customer_ids?: Array<string>;
|
|
338
|
+
/**
|
|
339
|
+
* The ID of the parent customer in the hierarchy. The desired parent customer must
|
|
340
|
+
* not be a child of another customer.
|
|
341
|
+
*/
|
|
342
|
+
parent_customer_id?: string | null;
|
|
343
|
+
}
|
|
344
|
+
export interface NewAccountingSyncConfiguration {
|
|
345
|
+
accounting_providers?: Array<AccountingProviderConfig> | null;
|
|
346
|
+
excluded?: boolean | null;
|
|
347
|
+
}
|
|
348
|
+
export interface NewAvalaraTaxConfiguration {
|
|
349
|
+
tax_exempt: boolean;
|
|
350
|
+
tax_provider: 'avalara';
|
|
351
|
+
tax_exemption_code?: string | null;
|
|
352
|
+
}
|
|
353
|
+
export interface NewReportingConfiguration {
|
|
354
|
+
exempt: boolean;
|
|
355
|
+
}
|
|
356
|
+
export interface NewSphereConfiguration {
|
|
357
|
+
tax_exempt: boolean;
|
|
358
|
+
tax_provider: 'sphere';
|
|
359
|
+
}
|
|
360
|
+
export interface NewTaxJarConfiguration {
|
|
361
|
+
tax_exempt: boolean;
|
|
362
|
+
tax_provider: 'taxjar';
|
|
363
|
+
}
|
|
457
364
|
export interface CustomerCreateParams {
|
|
458
365
|
/**
|
|
459
366
|
* A valid customer email, to be used for notifications. When Orb triggers payment
|
|
@@ -465,7 +372,7 @@ export interface CustomerCreateParams {
|
|
|
465
372
|
* The full name of the customer
|
|
466
373
|
*/
|
|
467
374
|
name: string;
|
|
468
|
-
accounting_sync_configuration?:
|
|
375
|
+
accounting_sync_configuration?: NewAccountingSyncConfiguration | null;
|
|
469
376
|
/**
|
|
470
377
|
* Additional email addresses for this customer. If populated, these email
|
|
471
378
|
* addresses will be CC'd for customer communications.
|
|
@@ -477,7 +384,7 @@ export interface CustomerCreateParams {
|
|
|
477
384
|
* when a payment provider is provided on customer creation.
|
|
478
385
|
*/
|
|
479
386
|
auto_collection?: boolean | null;
|
|
480
|
-
billing_address?:
|
|
387
|
+
billing_address?: AddressInput | null;
|
|
481
388
|
/**
|
|
482
389
|
* An ISO 4217 currency string used for the customer's invoices and balance. If not
|
|
483
390
|
* set at creation time, will be set at subscription creation time.
|
|
@@ -493,7 +400,7 @@ export interface CustomerCreateParams {
|
|
|
493
400
|
/**
|
|
494
401
|
* The hierarchical relationships for this customer.
|
|
495
402
|
*/
|
|
496
|
-
hierarchy?:
|
|
403
|
+
hierarchy?: CustomerHierarchyConfig | null;
|
|
497
404
|
/**
|
|
498
405
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
499
406
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -511,9 +418,9 @@ export interface CustomerCreateParams {
|
|
|
511
418
|
* is used for creating charges or invoices in the external system via Orb.
|
|
512
419
|
*/
|
|
513
420
|
payment_provider_id?: string | null;
|
|
514
|
-
reporting_configuration?:
|
|
515
|
-
shipping_address?:
|
|
516
|
-
tax_configuration?:
|
|
421
|
+
reporting_configuration?: NewReportingConfiguration | null;
|
|
422
|
+
shipping_address?: AddressInput | null;
|
|
423
|
+
tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
|
|
517
424
|
/**
|
|
518
425
|
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
519
426
|
* added to the headers of invoices.
|
|
@@ -621,7 +528,7 @@ export interface CustomerCreateParams {
|
|
|
621
528
|
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
622
529
|
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
623
530
|
*/
|
|
624
|
-
tax_id?:
|
|
531
|
+
tax_id?: Shared.CustomerTaxID | null;
|
|
625
532
|
/**
|
|
626
533
|
* A timezone identifier from the IANA timezone database, such as
|
|
627
534
|
* `"America/Los_Angeles"`. This defaults to your account's timezone if not set.
|
|
@@ -629,179 +536,8 @@ export interface CustomerCreateParams {
|
|
|
629
536
|
*/
|
|
630
537
|
timezone?: string | null;
|
|
631
538
|
}
|
|
632
|
-
export declare namespace CustomerCreateParams {
|
|
633
|
-
interface AccountingSyncConfiguration {
|
|
634
|
-
accounting_providers?: Array<AccountingSyncConfiguration.AccountingProvider> | null;
|
|
635
|
-
excluded?: boolean | null;
|
|
636
|
-
}
|
|
637
|
-
namespace AccountingSyncConfiguration {
|
|
638
|
-
interface AccountingProvider {
|
|
639
|
-
external_provider_id: string;
|
|
640
|
-
provider_type: string;
|
|
641
|
-
}
|
|
642
|
-
}
|
|
643
|
-
interface BillingAddress {
|
|
644
|
-
city?: string | null;
|
|
645
|
-
country?: string | null;
|
|
646
|
-
line1?: string | null;
|
|
647
|
-
line2?: string | null;
|
|
648
|
-
postal_code?: string | null;
|
|
649
|
-
state?: string | null;
|
|
650
|
-
}
|
|
651
|
-
/**
|
|
652
|
-
* The hierarchical relationships for this customer.
|
|
653
|
-
*/
|
|
654
|
-
interface Hierarchy {
|
|
655
|
-
/**
|
|
656
|
-
* A list of child customer IDs to add to the hierarchy. The desired child
|
|
657
|
-
* customers must not already be part of another hierarchy.
|
|
658
|
-
*/
|
|
659
|
-
child_customer_ids?: Array<string>;
|
|
660
|
-
/**
|
|
661
|
-
* The ID of the parent customer in the hierarchy. The desired parent customer must
|
|
662
|
-
* not be a child of another customer.
|
|
663
|
-
*/
|
|
664
|
-
parent_customer_id?: string | null;
|
|
665
|
-
}
|
|
666
|
-
interface ReportingConfiguration {
|
|
667
|
-
exempt: boolean;
|
|
668
|
-
}
|
|
669
|
-
interface ShippingAddress {
|
|
670
|
-
city?: string | null;
|
|
671
|
-
country?: string | null;
|
|
672
|
-
line1?: string | null;
|
|
673
|
-
line2?: string | null;
|
|
674
|
-
postal_code?: string | null;
|
|
675
|
-
state?: string | null;
|
|
676
|
-
}
|
|
677
|
-
interface NewAvalaraTaxConfiguration {
|
|
678
|
-
tax_exempt: boolean;
|
|
679
|
-
tax_provider: 'avalara';
|
|
680
|
-
tax_exemption_code?: string | null;
|
|
681
|
-
}
|
|
682
|
-
interface NewTaxJarConfiguration {
|
|
683
|
-
tax_exempt: boolean;
|
|
684
|
-
tax_provider: 'taxjar';
|
|
685
|
-
}
|
|
686
|
-
interface NewSphereConfiguration {
|
|
687
|
-
tax_exempt: boolean;
|
|
688
|
-
tax_provider: 'sphere';
|
|
689
|
-
}
|
|
690
|
-
/**
|
|
691
|
-
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
692
|
-
* added to the headers of invoices.
|
|
693
|
-
*
|
|
694
|
-
* ### Supported Tax ID Countries and Types
|
|
695
|
-
*
|
|
696
|
-
* | Country | Type | Description |
|
|
697
|
-
* | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
698
|
-
* | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
699
|
-
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
700
|
-
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
701
|
-
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
702
|
-
* | Austria | `eu_vat` | European VAT Number |
|
|
703
|
-
* | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
704
|
-
* | Belgium | `eu_vat` | European VAT Number |
|
|
705
|
-
* | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
706
|
-
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
707
|
-
* | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
708
|
-
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
709
|
-
* | Bulgaria | `eu_vat` | European VAT Number |
|
|
710
|
-
* | Canada | `ca_bn` | Canadian BN |
|
|
711
|
-
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
712
|
-
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
713
|
-
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
714
|
-
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
715
|
-
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
716
|
-
* | Chile | `cl_tin` | Chilean TIN |
|
|
717
|
-
* | China | `cn_tin` | Chinese Tax ID |
|
|
718
|
-
* | Colombia | `co_nit` | Colombian NIT Number |
|
|
719
|
-
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
720
|
-
* | Croatia | `eu_vat` | European VAT Number |
|
|
721
|
-
* | Cyprus | `eu_vat` | European VAT Number |
|
|
722
|
-
* | Czech Republic | `eu_vat` | European VAT Number |
|
|
723
|
-
* | Denmark | `eu_vat` | European VAT Number |
|
|
724
|
-
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
725
|
-
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
726
|
-
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
727
|
-
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
728
|
-
* | Estonia | `eu_vat` | European VAT Number |
|
|
729
|
-
* | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
730
|
-
* | Finland | `eu_vat` | European VAT Number |
|
|
731
|
-
* | France | `eu_vat` | European VAT Number |
|
|
732
|
-
* | Georgia | `ge_vat` | Georgian VAT |
|
|
733
|
-
* | Germany | `eu_vat` | European VAT Number |
|
|
734
|
-
* | Greece | `eu_vat` | European VAT Number |
|
|
735
|
-
* | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
736
|
-
* | Hungary | `eu_vat` | European VAT Number |
|
|
737
|
-
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
738
|
-
* | Iceland | `is_vat` | Icelandic VAT |
|
|
739
|
-
* | India | `in_gst` | Indian GST Number |
|
|
740
|
-
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
741
|
-
* | Ireland | `eu_vat` | European VAT Number |
|
|
742
|
-
* | Israel | `il_vat` | Israel VAT |
|
|
743
|
-
* | Italy | `eu_vat` | European VAT Number |
|
|
744
|
-
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
745
|
-
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
746
|
-
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
747
|
-
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
748
|
-
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
749
|
-
* | Latvia | `eu_vat` | European VAT Number |
|
|
750
|
-
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
751
|
-
* | Lithuania | `eu_vat` | European VAT Number |
|
|
752
|
-
* | Luxembourg | `eu_vat` | European VAT Number |
|
|
753
|
-
* | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
754
|
-
* | Malaysia | `my_itn` | Malaysian ITN |
|
|
755
|
-
* | Malaysia | `my_sst` | Malaysian SST Number |
|
|
756
|
-
* | Malta | `eu_vat ` | European VAT Number |
|
|
757
|
-
* | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
758
|
-
* | Netherlands | `eu_vat` | European VAT Number |
|
|
759
|
-
* | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
760
|
-
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
761
|
-
* | Norway | `no_vat` | Norwegian VAT Number |
|
|
762
|
-
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
763
|
-
* | Oman | `om_vat` | Omani VAT Number |
|
|
764
|
-
* | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
765
|
-
* | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
766
|
-
* | Poland | `eu_vat` | European VAT Number |
|
|
767
|
-
* | Portugal | `eu_vat` | European VAT Number |
|
|
768
|
-
* | Romania | `eu_vat` | European VAT Number |
|
|
769
|
-
* | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
770
|
-
* | Russia | `ru_inn` | Russian INN |
|
|
771
|
-
* | Russia | `ru_kpp` | Russian KPP |
|
|
772
|
-
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
773
|
-
* | Serbia | `rs_pib` | Serbian PIB Number |
|
|
774
|
-
* | Singapore | `sg_gst` | Singaporean GST |
|
|
775
|
-
* | Singapore | `sg_uen` | Singaporean UEN |
|
|
776
|
-
* | Slovakia | `eu_vat` | European VAT Number |
|
|
777
|
-
* | Slovenia | `eu_vat` | European VAT Number |
|
|
778
|
-
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
779
|
-
* | South Africa | `za_vat` | South African VAT Number |
|
|
780
|
-
* | South Korea | `kr_brn` | Korean BRN |
|
|
781
|
-
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
782
|
-
* | Spain | `eu_vat` | European VAT Number |
|
|
783
|
-
* | Sweden | `eu_vat` | European VAT Number |
|
|
784
|
-
* | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
785
|
-
* | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
786
|
-
* | Thailand | `th_vat` | Thai VAT |
|
|
787
|
-
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
788
|
-
* | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
789
|
-
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
790
|
-
* | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
791
|
-
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
792
|
-
* | United States | `us_ein` | United States EIN |
|
|
793
|
-
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
794
|
-
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
795
|
-
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
796
|
-
*/
|
|
797
|
-
interface TaxID {
|
|
798
|
-
country: 'AD' | 'AE' | 'AR' | 'AT' | 'AU' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'DO' | 'EC' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'KZ' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA';
|
|
799
|
-
type: 'ad_nrt' | 'ae_trn' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'bh_vat' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sv_nit' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'uy_ruc' | 've_rif' | 'vn_tin' | 'za_vat';
|
|
800
|
-
value: string;
|
|
801
|
-
}
|
|
802
|
-
}
|
|
803
539
|
export interface CustomerUpdateParams {
|
|
804
|
-
accounting_sync_configuration?:
|
|
540
|
+
accounting_sync_configuration?: NewAccountingSyncConfiguration | null;
|
|
805
541
|
/**
|
|
806
542
|
* Additional email addresses for this customer. If populated, these email
|
|
807
543
|
* addresses will be CC'd for customer communications.
|
|
@@ -813,7 +549,7 @@ export interface CustomerUpdateParams {
|
|
|
813
549
|
* when a payment provider is provided on customer creation.
|
|
814
550
|
*/
|
|
815
551
|
auto_collection?: boolean | null;
|
|
816
|
-
billing_address?:
|
|
552
|
+
billing_address?: AddressInput | null;
|
|
817
553
|
/**
|
|
818
554
|
* An ISO 4217 currency string used for the customer's invoices and balance. If not
|
|
819
555
|
* set at creation time, will be set at subscription creation time.
|
|
@@ -832,7 +568,7 @@ export interface CustomerUpdateParams {
|
|
|
832
568
|
/**
|
|
833
569
|
* The hierarchical relationships for this customer.
|
|
834
570
|
*/
|
|
835
|
-
hierarchy?:
|
|
571
|
+
hierarchy?: CustomerHierarchyConfig | null;
|
|
836
572
|
/**
|
|
837
573
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
838
574
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -858,9 +594,9 @@ export interface CustomerUpdateParams {
|
|
|
858
594
|
* is used for creating charges or invoices in the external system via Orb.
|
|
859
595
|
*/
|
|
860
596
|
payment_provider_id?: string | null;
|
|
861
|
-
reporting_configuration?:
|
|
862
|
-
shipping_address?:
|
|
863
|
-
tax_configuration?:
|
|
597
|
+
reporting_configuration?: NewReportingConfiguration | null;
|
|
598
|
+
shipping_address?: AddressInput | null;
|
|
599
|
+
tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
|
|
864
600
|
/**
|
|
865
601
|
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
866
602
|
* added to the headers of invoices.
|
|
@@ -968,178 +704,7 @@ export interface CustomerUpdateParams {
|
|
|
968
704
|
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
969
705
|
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
970
706
|
*/
|
|
971
|
-
tax_id?:
|
|
972
|
-
}
|
|
973
|
-
export declare namespace CustomerUpdateParams {
|
|
974
|
-
interface AccountingSyncConfiguration {
|
|
975
|
-
accounting_providers?: Array<AccountingSyncConfiguration.AccountingProvider> | null;
|
|
976
|
-
excluded?: boolean | null;
|
|
977
|
-
}
|
|
978
|
-
namespace AccountingSyncConfiguration {
|
|
979
|
-
interface AccountingProvider {
|
|
980
|
-
external_provider_id: string;
|
|
981
|
-
provider_type: string;
|
|
982
|
-
}
|
|
983
|
-
}
|
|
984
|
-
interface BillingAddress {
|
|
985
|
-
city?: string | null;
|
|
986
|
-
country?: string | null;
|
|
987
|
-
line1?: string | null;
|
|
988
|
-
line2?: string | null;
|
|
989
|
-
postal_code?: string | null;
|
|
990
|
-
state?: string | null;
|
|
991
|
-
}
|
|
992
|
-
/**
|
|
993
|
-
* The hierarchical relationships for this customer.
|
|
994
|
-
*/
|
|
995
|
-
interface Hierarchy {
|
|
996
|
-
/**
|
|
997
|
-
* A list of child customer IDs to add to the hierarchy. The desired child
|
|
998
|
-
* customers must not already be part of another hierarchy.
|
|
999
|
-
*/
|
|
1000
|
-
child_customer_ids?: Array<string>;
|
|
1001
|
-
/**
|
|
1002
|
-
* The ID of the parent customer in the hierarchy. The desired parent customer must
|
|
1003
|
-
* not be a child of another customer.
|
|
1004
|
-
*/
|
|
1005
|
-
parent_customer_id?: string | null;
|
|
1006
|
-
}
|
|
1007
|
-
interface ReportingConfiguration {
|
|
1008
|
-
exempt: boolean;
|
|
1009
|
-
}
|
|
1010
|
-
interface ShippingAddress {
|
|
1011
|
-
city?: string | null;
|
|
1012
|
-
country?: string | null;
|
|
1013
|
-
line1?: string | null;
|
|
1014
|
-
line2?: string | null;
|
|
1015
|
-
postal_code?: string | null;
|
|
1016
|
-
state?: string | null;
|
|
1017
|
-
}
|
|
1018
|
-
interface NewAvalaraTaxConfiguration {
|
|
1019
|
-
tax_exempt: boolean;
|
|
1020
|
-
tax_provider: 'avalara';
|
|
1021
|
-
tax_exemption_code?: string | null;
|
|
1022
|
-
}
|
|
1023
|
-
interface NewTaxJarConfiguration {
|
|
1024
|
-
tax_exempt: boolean;
|
|
1025
|
-
tax_provider: 'taxjar';
|
|
1026
|
-
}
|
|
1027
|
-
interface NewSphereConfiguration {
|
|
1028
|
-
tax_exempt: boolean;
|
|
1029
|
-
tax_provider: 'sphere';
|
|
1030
|
-
}
|
|
1031
|
-
/**
|
|
1032
|
-
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
1033
|
-
* added to the headers of invoices.
|
|
1034
|
-
*
|
|
1035
|
-
* ### Supported Tax ID Countries and Types
|
|
1036
|
-
*
|
|
1037
|
-
* | Country | Type | Description |
|
|
1038
|
-
* | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
1039
|
-
* | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
1040
|
-
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
1041
|
-
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
1042
|
-
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
1043
|
-
* | Austria | `eu_vat` | European VAT Number |
|
|
1044
|
-
* | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
1045
|
-
* | Belgium | `eu_vat` | European VAT Number |
|
|
1046
|
-
* | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
1047
|
-
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
1048
|
-
* | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
1049
|
-
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
1050
|
-
* | Bulgaria | `eu_vat` | European VAT Number |
|
|
1051
|
-
* | Canada | `ca_bn` | Canadian BN |
|
|
1052
|
-
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
1053
|
-
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
1054
|
-
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
1055
|
-
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
1056
|
-
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
1057
|
-
* | Chile | `cl_tin` | Chilean TIN |
|
|
1058
|
-
* | China | `cn_tin` | Chinese Tax ID |
|
|
1059
|
-
* | Colombia | `co_nit` | Colombian NIT Number |
|
|
1060
|
-
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
1061
|
-
* | Croatia | `eu_vat` | European VAT Number |
|
|
1062
|
-
* | Cyprus | `eu_vat` | European VAT Number |
|
|
1063
|
-
* | Czech Republic | `eu_vat` | European VAT Number |
|
|
1064
|
-
* | Denmark | `eu_vat` | European VAT Number |
|
|
1065
|
-
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
1066
|
-
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
1067
|
-
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
1068
|
-
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
1069
|
-
* | Estonia | `eu_vat` | European VAT Number |
|
|
1070
|
-
* | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
1071
|
-
* | Finland | `eu_vat` | European VAT Number |
|
|
1072
|
-
* | France | `eu_vat` | European VAT Number |
|
|
1073
|
-
* | Georgia | `ge_vat` | Georgian VAT |
|
|
1074
|
-
* | Germany | `eu_vat` | European VAT Number |
|
|
1075
|
-
* | Greece | `eu_vat` | European VAT Number |
|
|
1076
|
-
* | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
1077
|
-
* | Hungary | `eu_vat` | European VAT Number |
|
|
1078
|
-
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
1079
|
-
* | Iceland | `is_vat` | Icelandic VAT |
|
|
1080
|
-
* | India | `in_gst` | Indian GST Number |
|
|
1081
|
-
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
1082
|
-
* | Ireland | `eu_vat` | European VAT Number |
|
|
1083
|
-
* | Israel | `il_vat` | Israel VAT |
|
|
1084
|
-
* | Italy | `eu_vat` | European VAT Number |
|
|
1085
|
-
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
1086
|
-
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
1087
|
-
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
1088
|
-
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
1089
|
-
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
1090
|
-
* | Latvia | `eu_vat` | European VAT Number |
|
|
1091
|
-
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
1092
|
-
* | Lithuania | `eu_vat` | European VAT Number |
|
|
1093
|
-
* | Luxembourg | `eu_vat` | European VAT Number |
|
|
1094
|
-
* | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
1095
|
-
* | Malaysia | `my_itn` | Malaysian ITN |
|
|
1096
|
-
* | Malaysia | `my_sst` | Malaysian SST Number |
|
|
1097
|
-
* | Malta | `eu_vat ` | European VAT Number |
|
|
1098
|
-
* | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
1099
|
-
* | Netherlands | `eu_vat` | European VAT Number |
|
|
1100
|
-
* | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
1101
|
-
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
1102
|
-
* | Norway | `no_vat` | Norwegian VAT Number |
|
|
1103
|
-
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
1104
|
-
* | Oman | `om_vat` | Omani VAT Number |
|
|
1105
|
-
* | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
1106
|
-
* | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
1107
|
-
* | Poland | `eu_vat` | European VAT Number |
|
|
1108
|
-
* | Portugal | `eu_vat` | European VAT Number |
|
|
1109
|
-
* | Romania | `eu_vat` | European VAT Number |
|
|
1110
|
-
* | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
1111
|
-
* | Russia | `ru_inn` | Russian INN |
|
|
1112
|
-
* | Russia | `ru_kpp` | Russian KPP |
|
|
1113
|
-
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
1114
|
-
* | Serbia | `rs_pib` | Serbian PIB Number |
|
|
1115
|
-
* | Singapore | `sg_gst` | Singaporean GST |
|
|
1116
|
-
* | Singapore | `sg_uen` | Singaporean UEN |
|
|
1117
|
-
* | Slovakia | `eu_vat` | European VAT Number |
|
|
1118
|
-
* | Slovenia | `eu_vat` | European VAT Number |
|
|
1119
|
-
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
1120
|
-
* | South Africa | `za_vat` | South African VAT Number |
|
|
1121
|
-
* | South Korea | `kr_brn` | Korean BRN |
|
|
1122
|
-
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
1123
|
-
* | Spain | `eu_vat` | European VAT Number |
|
|
1124
|
-
* | Sweden | `eu_vat` | European VAT Number |
|
|
1125
|
-
* | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
1126
|
-
* | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
1127
|
-
* | Thailand | `th_vat` | Thai VAT |
|
|
1128
|
-
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
1129
|
-
* | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
1130
|
-
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
1131
|
-
* | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
1132
|
-
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
1133
|
-
* | United States | `us_ein` | United States EIN |
|
|
1134
|
-
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
1135
|
-
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
1136
|
-
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
1137
|
-
*/
|
|
1138
|
-
interface TaxID {
|
|
1139
|
-
country: 'AD' | 'AE' | 'AR' | 'AT' | 'AU' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'DO' | 'EC' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'KZ' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA';
|
|
1140
|
-
type: 'ad_nrt' | 'ae_trn' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'bh_vat' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sv_nit' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'uy_ruc' | 've_rif' | 'vn_tin' | 'za_vat';
|
|
1141
|
-
value: string;
|
|
1142
|
-
}
|
|
707
|
+
tax_id?: Shared.CustomerTaxID | null;
|
|
1143
708
|
}
|
|
1144
709
|
export interface CustomerListParams extends PageParams {
|
|
1145
710
|
'created_at[gt]'?: string | null;
|
|
@@ -1148,7 +713,7 @@ export interface CustomerListParams extends PageParams {
|
|
|
1148
713
|
'created_at[lte]'?: string | null;
|
|
1149
714
|
}
|
|
1150
715
|
export interface CustomerUpdateByExternalIDParams {
|
|
1151
|
-
accounting_sync_configuration?:
|
|
716
|
+
accounting_sync_configuration?: NewAccountingSyncConfiguration | null;
|
|
1152
717
|
/**
|
|
1153
718
|
* Additional email addresses for this customer. If populated, these email
|
|
1154
719
|
* addresses will be CC'd for customer communications.
|
|
@@ -1160,7 +725,7 @@ export interface CustomerUpdateByExternalIDParams {
|
|
|
1160
725
|
* when a payment provider is provided on customer creation.
|
|
1161
726
|
*/
|
|
1162
727
|
auto_collection?: boolean | null;
|
|
1163
|
-
billing_address?:
|
|
728
|
+
billing_address?: AddressInput | null;
|
|
1164
729
|
/**
|
|
1165
730
|
* An ISO 4217 currency string used for the customer's invoices and balance. If not
|
|
1166
731
|
* set at creation time, will be set at subscription creation time.
|
|
@@ -1179,7 +744,7 @@ export interface CustomerUpdateByExternalIDParams {
|
|
|
1179
744
|
/**
|
|
1180
745
|
* The hierarchical relationships for this customer.
|
|
1181
746
|
*/
|
|
1182
|
-
hierarchy?:
|
|
747
|
+
hierarchy?: CustomerHierarchyConfig | null;
|
|
1183
748
|
/**
|
|
1184
749
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1185
750
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1205,176 +770,9 @@ export interface CustomerUpdateByExternalIDParams {
|
|
|
1205
770
|
* is used for creating charges or invoices in the external system via Orb.
|
|
1206
771
|
*/
|
|
1207
772
|
payment_provider_id?: string | null;
|
|
1208
|
-
reporting_configuration?:
|
|
1209
|
-
shipping_address?:
|
|
1210
|
-
tax_configuration?:
|
|
1211
|
-
/**
|
|
1212
|
-
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
1213
|
-
* added to the headers of invoices.
|
|
1214
|
-
*
|
|
1215
|
-
* ### Supported Tax ID Countries and Types
|
|
1216
|
-
*
|
|
1217
|
-
* | Country | Type | Description |
|
|
1218
|
-
* | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
1219
|
-
* | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
1220
|
-
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
1221
|
-
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
1222
|
-
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
1223
|
-
* | Austria | `eu_vat` | European VAT Number |
|
|
1224
|
-
* | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
1225
|
-
* | Belgium | `eu_vat` | European VAT Number |
|
|
1226
|
-
* | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
1227
|
-
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
1228
|
-
* | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
1229
|
-
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
1230
|
-
* | Bulgaria | `eu_vat` | European VAT Number |
|
|
1231
|
-
* | Canada | `ca_bn` | Canadian BN |
|
|
1232
|
-
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
1233
|
-
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
1234
|
-
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
1235
|
-
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
1236
|
-
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
1237
|
-
* | Chile | `cl_tin` | Chilean TIN |
|
|
1238
|
-
* | China | `cn_tin` | Chinese Tax ID |
|
|
1239
|
-
* | Colombia | `co_nit` | Colombian NIT Number |
|
|
1240
|
-
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
1241
|
-
* | Croatia | `eu_vat` | European VAT Number |
|
|
1242
|
-
* | Cyprus | `eu_vat` | European VAT Number |
|
|
1243
|
-
* | Czech Republic | `eu_vat` | European VAT Number |
|
|
1244
|
-
* | Denmark | `eu_vat` | European VAT Number |
|
|
1245
|
-
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
1246
|
-
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
1247
|
-
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
1248
|
-
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
1249
|
-
* | Estonia | `eu_vat` | European VAT Number |
|
|
1250
|
-
* | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
1251
|
-
* | Finland | `eu_vat` | European VAT Number |
|
|
1252
|
-
* | France | `eu_vat` | European VAT Number |
|
|
1253
|
-
* | Georgia | `ge_vat` | Georgian VAT |
|
|
1254
|
-
* | Germany | `eu_vat` | European VAT Number |
|
|
1255
|
-
* | Greece | `eu_vat` | European VAT Number |
|
|
1256
|
-
* | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
1257
|
-
* | Hungary | `eu_vat` | European VAT Number |
|
|
1258
|
-
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
1259
|
-
* | Iceland | `is_vat` | Icelandic VAT |
|
|
1260
|
-
* | India | `in_gst` | Indian GST Number |
|
|
1261
|
-
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
1262
|
-
* | Ireland | `eu_vat` | European VAT Number |
|
|
1263
|
-
* | Israel | `il_vat` | Israel VAT |
|
|
1264
|
-
* | Italy | `eu_vat` | European VAT Number |
|
|
1265
|
-
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
1266
|
-
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
1267
|
-
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
1268
|
-
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
1269
|
-
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
1270
|
-
* | Latvia | `eu_vat` | European VAT Number |
|
|
1271
|
-
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
1272
|
-
* | Lithuania | `eu_vat` | European VAT Number |
|
|
1273
|
-
* | Luxembourg | `eu_vat` | European VAT Number |
|
|
1274
|
-
* | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
1275
|
-
* | Malaysia | `my_itn` | Malaysian ITN |
|
|
1276
|
-
* | Malaysia | `my_sst` | Malaysian SST Number |
|
|
1277
|
-
* | Malta | `eu_vat ` | European VAT Number |
|
|
1278
|
-
* | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
1279
|
-
* | Netherlands | `eu_vat` | European VAT Number |
|
|
1280
|
-
* | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
1281
|
-
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
1282
|
-
* | Norway | `no_vat` | Norwegian VAT Number |
|
|
1283
|
-
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
1284
|
-
* | Oman | `om_vat` | Omani VAT Number |
|
|
1285
|
-
* | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
1286
|
-
* | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
1287
|
-
* | Poland | `eu_vat` | European VAT Number |
|
|
1288
|
-
* | Portugal | `eu_vat` | European VAT Number |
|
|
1289
|
-
* | Romania | `eu_vat` | European VAT Number |
|
|
1290
|
-
* | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
1291
|
-
* | Russia | `ru_inn` | Russian INN |
|
|
1292
|
-
* | Russia | `ru_kpp` | Russian KPP |
|
|
1293
|
-
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
1294
|
-
* | Serbia | `rs_pib` | Serbian PIB Number |
|
|
1295
|
-
* | Singapore | `sg_gst` | Singaporean GST |
|
|
1296
|
-
* | Singapore | `sg_uen` | Singaporean UEN |
|
|
1297
|
-
* | Slovakia | `eu_vat` | European VAT Number |
|
|
1298
|
-
* | Slovenia | `eu_vat` | European VAT Number |
|
|
1299
|
-
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
1300
|
-
* | South Africa | `za_vat` | South African VAT Number |
|
|
1301
|
-
* | South Korea | `kr_brn` | Korean BRN |
|
|
1302
|
-
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
1303
|
-
* | Spain | `eu_vat` | European VAT Number |
|
|
1304
|
-
* | Sweden | `eu_vat` | European VAT Number |
|
|
1305
|
-
* | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
1306
|
-
* | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
1307
|
-
* | Thailand | `th_vat` | Thai VAT |
|
|
1308
|
-
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
1309
|
-
* | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
1310
|
-
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
1311
|
-
* | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
1312
|
-
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
1313
|
-
* | United States | `us_ein` | United States EIN |
|
|
1314
|
-
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
1315
|
-
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
1316
|
-
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
1317
|
-
*/
|
|
1318
|
-
tax_id?: CustomerUpdateByExternalIDParams.TaxID | null;
|
|
1319
|
-
}
|
|
1320
|
-
export declare namespace CustomerUpdateByExternalIDParams {
|
|
1321
|
-
interface AccountingSyncConfiguration {
|
|
1322
|
-
accounting_providers?: Array<AccountingSyncConfiguration.AccountingProvider> | null;
|
|
1323
|
-
excluded?: boolean | null;
|
|
1324
|
-
}
|
|
1325
|
-
namespace AccountingSyncConfiguration {
|
|
1326
|
-
interface AccountingProvider {
|
|
1327
|
-
external_provider_id: string;
|
|
1328
|
-
provider_type: string;
|
|
1329
|
-
}
|
|
1330
|
-
}
|
|
1331
|
-
interface BillingAddress {
|
|
1332
|
-
city?: string | null;
|
|
1333
|
-
country?: string | null;
|
|
1334
|
-
line1?: string | null;
|
|
1335
|
-
line2?: string | null;
|
|
1336
|
-
postal_code?: string | null;
|
|
1337
|
-
state?: string | null;
|
|
1338
|
-
}
|
|
1339
|
-
/**
|
|
1340
|
-
* The hierarchical relationships for this customer.
|
|
1341
|
-
*/
|
|
1342
|
-
interface Hierarchy {
|
|
1343
|
-
/**
|
|
1344
|
-
* A list of child customer IDs to add to the hierarchy. The desired child
|
|
1345
|
-
* customers must not already be part of another hierarchy.
|
|
1346
|
-
*/
|
|
1347
|
-
child_customer_ids?: Array<string>;
|
|
1348
|
-
/**
|
|
1349
|
-
* The ID of the parent customer in the hierarchy. The desired parent customer must
|
|
1350
|
-
* not be a child of another customer.
|
|
1351
|
-
*/
|
|
1352
|
-
parent_customer_id?: string | null;
|
|
1353
|
-
}
|
|
1354
|
-
interface ReportingConfiguration {
|
|
1355
|
-
exempt: boolean;
|
|
1356
|
-
}
|
|
1357
|
-
interface ShippingAddress {
|
|
1358
|
-
city?: string | null;
|
|
1359
|
-
country?: string | null;
|
|
1360
|
-
line1?: string | null;
|
|
1361
|
-
line2?: string | null;
|
|
1362
|
-
postal_code?: string | null;
|
|
1363
|
-
state?: string | null;
|
|
1364
|
-
}
|
|
1365
|
-
interface NewAvalaraTaxConfiguration {
|
|
1366
|
-
tax_exempt: boolean;
|
|
1367
|
-
tax_provider: 'avalara';
|
|
1368
|
-
tax_exemption_code?: string | null;
|
|
1369
|
-
}
|
|
1370
|
-
interface NewTaxJarConfiguration {
|
|
1371
|
-
tax_exempt: boolean;
|
|
1372
|
-
tax_provider: 'taxjar';
|
|
1373
|
-
}
|
|
1374
|
-
interface NewSphereConfiguration {
|
|
1375
|
-
tax_exempt: boolean;
|
|
1376
|
-
tax_provider: 'sphere';
|
|
1377
|
-
}
|
|
773
|
+
reporting_configuration?: NewReportingConfiguration | null;
|
|
774
|
+
shipping_address?: AddressInput | null;
|
|
775
|
+
tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
|
|
1378
776
|
/**
|
|
1379
777
|
* Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
1380
778
|
* added to the headers of invoices.
|
|
@@ -1482,14 +880,10 @@ export declare namespace CustomerUpdateByExternalIDParams {
|
|
|
1482
880
|
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
1483
881
|
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
1484
882
|
*/
|
|
1485
|
-
|
|
1486
|
-
country: 'AD' | 'AE' | 'AR' | 'AT' | 'AU' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'DO' | 'EC' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'KZ' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA';
|
|
1487
|
-
type: 'ad_nrt' | 'ae_trn' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'bh_vat' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sv_nit' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'uy_ruc' | 've_rif' | 'vn_tin' | 'za_vat';
|
|
1488
|
-
value: string;
|
|
1489
|
-
}
|
|
883
|
+
tax_id?: Shared.CustomerTaxID | null;
|
|
1490
884
|
}
|
|
1491
885
|
export declare namespace Customers {
|
|
1492
|
-
export { type Customer as Customer, CustomersPage as CustomersPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerUpdateByExternalIDParams as CustomerUpdateByExternalIDParams, };
|
|
886
|
+
export { type AccountingProviderConfig as AccountingProviderConfig, type AddressInput as AddressInput, type Customer as Customer, type CustomerHierarchyConfig as CustomerHierarchyConfig, type NewAccountingSyncConfiguration as NewAccountingSyncConfiguration, type NewAvalaraTaxConfiguration as NewAvalaraTaxConfiguration, type NewReportingConfiguration as NewReportingConfiguration, type NewSphereConfiguration as NewSphereConfiguration, type NewTaxJarConfiguration as NewTaxJarConfiguration, CustomersPage as CustomersPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerUpdateByExternalIDParams as CustomerUpdateByExternalIDParams, };
|
|
1493
887
|
export { Costs as Costs, type CostListResponse as CostListResponse, type CostListByExternalIDResponse as CostListByExternalIDResponse, type CostListParams as CostListParams, type CostListByExternalIDParams as CostListByExternalIDParams, };
|
|
1494
888
|
export { Credits as Credits, type CreditListResponse as CreditListResponse, type CreditListByExternalIDResponse as CreditListByExternalIDResponse, CreditListResponsesPage as CreditListResponsesPage, CreditListByExternalIDResponsesPage as CreditListByExternalIDResponsesPage, type CreditListParams as CreditListParams, type CreditListByExternalIDParams as CreditListByExternalIDParams, };
|
|
1495
889
|
export { BalanceTransactions as BalanceTransactions, type BalanceTransactionCreateResponse as BalanceTransactionCreateResponse, type BalanceTransactionListResponse as BalanceTransactionListResponse, BalanceTransactionListResponsesPage as BalanceTransactionListResponsesPage, type BalanceTransactionCreateParams as BalanceTransactionCreateParams, type BalanceTransactionListParams as BalanceTransactionListParams, };
|