@chift/chift-nodejs 1.0.18 → 1.0.19

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.
Files changed (73) hide show
  1. package/dist/src/helpers/openapi.d.ts +3 -0
  2. package/dist/src/helpers/openapi.js +18 -0
  3. package/dist/src/helpers/settings.d.ts +4 -0
  4. package/dist/src/helpers/settings.js +5 -0
  5. package/dist/src/index.d.ts +1 -0
  6. package/dist/src/modules/accounting.d.ts +68 -0
  7. package/dist/src/modules/accounting.js +326 -0
  8. package/dist/src/modules/api.d.ts +18351 -0
  9. package/dist/src/modules/api.js +36 -0
  10. package/dist/src/modules/consumer.d.ts +3622 -0
  11. package/dist/src/modules/consumer.js +142 -0
  12. package/dist/src/modules/consumers.d.ts +18237 -0
  13. package/dist/src/modules/consumers.js +51 -0
  14. package/dist/src/modules/custom.d.ts +8 -0
  15. package/dist/src/modules/custom.js +36 -0
  16. package/dist/src/modules/datastores.d.ts +18 -0
  17. package/dist/src/modules/datastores.js +23 -0
  18. package/dist/src/modules/ecommerce.d.ts +24 -0
  19. package/dist/src/modules/ecommerce.js +97 -0
  20. package/dist/src/modules/flow.d.ts +15 -0
  21. package/dist/src/modules/flow.js +156 -0
  22. package/dist/src/modules/integrations.d.ts +23 -0
  23. package/dist/src/modules/integrations.js +23 -0
  24. package/dist/src/modules/internalApi.d.ts +24 -0
  25. package/dist/src/modules/internalApi.js +175 -0
  26. package/dist/src/modules/invoicing.d.ts +20 -0
  27. package/dist/src/modules/invoicing.js +90 -0
  28. package/dist/src/modules/payment.d.ts +14 -0
  29. package/dist/src/modules/payment.js +41 -0
  30. package/dist/src/modules/pms.d.ts +15 -0
  31. package/dist/src/modules/pms.js +47 -0
  32. package/dist/src/modules/pos.d.ts +26 -0
  33. package/dist/src/modules/pos.js +101 -0
  34. package/dist/src/modules/sync.d.ts +14654 -0
  35. package/dist/src/modules/sync.js +73 -0
  36. package/dist/src/modules/syncs.d.ts +11 -0
  37. package/dist/src/modules/syncs.js +39 -0
  38. package/dist/src/modules/webhooks.d.ts +58 -0
  39. package/dist/src/modules/webhooks.js +53 -0
  40. package/{src/types/api.ts → dist/src/types/api.d.ts} +4 -12
  41. package/dist/src/types/api.js +2 -0
  42. package/{src/types/consumers.ts → dist/src/types/consumers.d.ts} +0 -1
  43. package/dist/src/types/consumers.js +2 -0
  44. package/dist/src/types/public-api/mappings.js +2 -0
  45. package/dist/src/types/public-api/schema.d.ts +15294 -0
  46. package/{src/types/sync.ts → dist/src/types/sync.d.ts} +5 -6
  47. package/dist/src/types/sync.js +2 -0
  48. package/dist/test/modules/accounting.test.d.ts +1 -0
  49. package/dist/test/modules/accounting.test.js +590 -0
  50. package/dist/test/modules/consumer.test.d.ts +1 -0
  51. package/dist/test/modules/consumer.test.js +89 -0
  52. package/dist/test/modules/consumers.test.d.ts +1 -0
  53. package/dist/test/modules/consumers.test.js +109 -0
  54. package/dist/test/modules/ecommerce.test.d.ts +1 -0
  55. package/dist/test/modules/ecommerce.test.js +224 -0
  56. package/dist/test/modules/integrations.test.d.ts +1 -0
  57. package/dist/test/modules/integrations.test.js +54 -0
  58. package/dist/test/modules/invoicing.test.d.ts +1 -0
  59. package/dist/test/modules/invoicing.test.js +115 -0
  60. package/dist/test/modules/payment.test.d.ts +1 -0
  61. package/dist/test/modules/payment.test.js +88 -0
  62. package/dist/test/modules/pms.test.d.ts +1 -0
  63. package/dist/test/modules/pms.test.js +90 -0
  64. package/dist/test/modules/pos.test.d.ts +1 -0
  65. package/dist/test/modules/pos.test.js +179 -0
  66. package/dist/test/modules/sync.test.d.ts +1 -0
  67. package/dist/test/modules/sync.test.js +93 -0
  68. package/dist/test/modules/syncs.test.d.ts +1 -0
  69. package/dist/test/modules/syncs.test.js +53 -0
  70. package/dist/test/modules/webhooks.test.d.ts +1 -0
  71. package/dist/test/modules/webhooks.test.js +120 -0
  72. package/package.json +3 -2
  73. /package/{src/types/public-api/mappings.ts → dist/src/types/public-api/mappings.d.ts} +0 -0
@@ -0,0 +1,3622 @@
1
+ import { operations, components } from '../types/public-api/schema';
2
+ import { InternalAPI } from './internalApi';
3
+ import { chiftOperations } from '../types/public-api/mappings';
4
+ import { SimpleResponseModel } from '../types/sync';
5
+ import { ConsumerLog } from '../types/consumers';
6
+ declare const Consumer: (internalApi: InternalAPI, body: operations[chiftOperations['getConsumerById']]['responses'][200]['content']['application/json']) => {
7
+ consumerId: string;
8
+ getConnections: () => Promise<{
9
+ connectionid: string;
10
+ name: string;
11
+ integration: string;
12
+ integrationid: number;
13
+ api: string;
14
+ data?: Record<string, never> | undefined;
15
+ status: "active" | "inactive";
16
+ agent?: {
17
+ status: "up" | "down";
18
+ } | undefined;
19
+ }[]>;
20
+ createConnection: (body?: components['schemas']['backbone_api__app__routers__connections__PostConnectionItem']) => Promise<{
21
+ url: string;
22
+ }>;
23
+ updateConnection: (connectionId: string, body?: components['schemas']['PatchConnectionItem']) => Promise<{
24
+ url: string;
25
+ }>;
26
+ deleteConnection: (connectionId: string) => Promise<{
27
+ headers: {
28
+ [name: string]: unknown;
29
+ };
30
+ content?: undefined;
31
+ }>;
32
+ enableFlow: (syncId: string, flowId: string, body: components['schemas']['EnableFlowConsumer']) => Promise<SimpleResponseModel>;
33
+ getSyncUrl: (body: components['schemas']['CreateConsumerSyncItem']) => Promise<{
34
+ url: string;
35
+ }>;
36
+ name: string;
37
+ redirect_url: string | undefined;
38
+ email: string | undefined;
39
+ pos: import("../types/api").ApiFor<{
40
+ getLocations(): import("../types/api").RequestData<{
41
+ id: string;
42
+ name: string;
43
+ timezone?: string | undefined;
44
+ address?: {
45
+ address_type?: string | undefined;
46
+ name?: string | undefined;
47
+ street?: string | undefined;
48
+ number?: string | undefined;
49
+ box?: string | undefined;
50
+ city?: string | undefined;
51
+ postal_code?: string | undefined;
52
+ country?: string | undefined;
53
+ } | undefined;
54
+ }[]>;
55
+ getOrders(params: {
56
+ date_from: string;
57
+ date_to: string;
58
+ location_id?: string | undefined;
59
+ state?: "open" | "closed" | "all" | undefined;
60
+ }): import("../types/api").RequestData<{
61
+ id: string;
62
+ order_number?: string | undefined;
63
+ creation_date: string;
64
+ closing_date?: string | undefined;
65
+ service_date?: string | undefined;
66
+ device_id?: string | undefined;
67
+ total: number;
68
+ tax_amount: number;
69
+ total_discount: number;
70
+ total_refund: number;
71
+ total_tip: number;
72
+ delivery_fee: number;
73
+ currency?: string | undefined;
74
+ country?: string | undefined;
75
+ loyalty?: number | undefined;
76
+ customer_id?: string | undefined;
77
+ location_id?: string | undefined;
78
+ taxes?: {
79
+ tax_rate: number;
80
+ tax_amount: number;
81
+ total: number;
82
+ }[] | undefined;
83
+ guests?: number | undefined;
84
+ payments: {
85
+ id?: string | undefined;
86
+ payment_method_id?: string | undefined;
87
+ payment_method_name?: string | undefined;
88
+ total: number;
89
+ tip: number;
90
+ status: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised";
91
+ currency?: string | undefined;
92
+ date?: string | undefined;
93
+ }[];
94
+ items: {
95
+ id: string;
96
+ quantity: number;
97
+ unit_price: number;
98
+ total: number;
99
+ tax_amount: number;
100
+ tax_rate?: number | undefined;
101
+ description?: string | undefined;
102
+ discounts: {
103
+ name?: string | undefined;
104
+ total: number;
105
+ }[];
106
+ product_id?: string | undefined;
107
+ accounting_category_id?: string | undefined;
108
+ }[];
109
+ }[]>;
110
+ getCustomers(params?: {
111
+ search?: string | undefined;
112
+ email?: string | undefined;
113
+ phone?: string | undefined;
114
+ } | undefined): import("../types/api").RequestData<{
115
+ id: string;
116
+ first_name?: string | undefined;
117
+ last_name?: string | undefined;
118
+ name: string;
119
+ phone?: string | undefined;
120
+ email?: string | undefined;
121
+ created_on?: string | undefined;
122
+ addresses?: {
123
+ address_type?: string | undefined;
124
+ name?: string | undefined;
125
+ street?: string | undefined;
126
+ number?: string | undefined;
127
+ box?: string | undefined;
128
+ city?: string | undefined;
129
+ postal_code?: string | undefined;
130
+ country?: string | undefined;
131
+ }[] | undefined;
132
+ loyalty?: number | undefined;
133
+ birthdate?: string | undefined;
134
+ }[]>;
135
+ getOrder(orderId: string): import("../types/api").RequestData<{
136
+ id: string;
137
+ order_number?: string | undefined;
138
+ creation_date: string;
139
+ closing_date?: string | undefined;
140
+ service_date?: string | undefined;
141
+ device_id?: string | undefined;
142
+ total: number;
143
+ tax_amount: number;
144
+ total_discount: number;
145
+ total_refund: number;
146
+ total_tip: number;
147
+ delivery_fee: number;
148
+ currency?: string | undefined;
149
+ country?: string | undefined;
150
+ loyalty?: number | undefined;
151
+ customer_id?: string | undefined;
152
+ location_id?: string | undefined;
153
+ taxes?: {
154
+ tax_rate: number;
155
+ tax_amount: number;
156
+ total: number;
157
+ }[] | undefined;
158
+ guests?: number | undefined;
159
+ payments: {
160
+ id?: string | undefined;
161
+ payment_method_id?: string | undefined;
162
+ payment_method_name?: string | undefined;
163
+ total: number;
164
+ tip: number;
165
+ status: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised";
166
+ currency?: string | undefined;
167
+ date?: string | undefined;
168
+ }[];
169
+ items: {
170
+ id: string;
171
+ quantity: number;
172
+ unit_price: number;
173
+ total: number;
174
+ tax_amount: number;
175
+ tax_rate?: number | undefined;
176
+ description?: string | undefined;
177
+ discounts: {
178
+ name?: string | undefined;
179
+ total: number;
180
+ }[];
181
+ product_id?: string | undefined;
182
+ accounting_category_id?: string | undefined;
183
+ }[];
184
+ }>;
185
+ getCustomer(customerId: string): import("../types/api").RequestData<{
186
+ id: string;
187
+ first_name?: string | undefined;
188
+ last_name?: string | undefined;
189
+ name: string;
190
+ phone?: string | undefined;
191
+ email?: string | undefined;
192
+ created_on?: string | undefined;
193
+ addresses?: {
194
+ address_type?: string | undefined;
195
+ name?: string | undefined;
196
+ street?: string | undefined;
197
+ number?: string | undefined;
198
+ box?: string | undefined;
199
+ city?: string | undefined;
200
+ postal_code?: string | undefined;
201
+ country?: string | undefined;
202
+ }[] | undefined;
203
+ loyalty?: number | undefined;
204
+ birthdate?: string | undefined;
205
+ }>;
206
+ createCustomer(customer: {
207
+ first_name: string;
208
+ last_name: string;
209
+ phone?: string | undefined;
210
+ email?: string | undefined;
211
+ address?: {
212
+ name: string;
213
+ street?: string | undefined;
214
+ number?: string | undefined;
215
+ box?: string | undefined;
216
+ city: string;
217
+ postal_code: string;
218
+ country?: string | undefined;
219
+ } | undefined;
220
+ }): import("../types/api").RequestData<{
221
+ id: string;
222
+ first_name?: string | undefined;
223
+ last_name?: string | undefined;
224
+ name: string;
225
+ phone?: string | undefined;
226
+ email?: string | undefined;
227
+ created_on?: string | undefined;
228
+ addresses?: {
229
+ address_type?: string | undefined;
230
+ name?: string | undefined;
231
+ street?: string | undefined;
232
+ number?: string | undefined;
233
+ box?: string | undefined;
234
+ city?: string | undefined;
235
+ postal_code?: string | undefined;
236
+ country?: string | undefined;
237
+ }[] | undefined;
238
+ loyalty?: number | undefined;
239
+ birthdate?: string | undefined;
240
+ }>;
241
+ getPaymentMethods(params?: {
242
+ location_id?: string | undefined;
243
+ } | undefined): import("../types/api").RequestData<{
244
+ id: string;
245
+ name: string;
246
+ extra?: string | undefined;
247
+ }[]>;
248
+ getProductCategories(params?: {
249
+ location_id?: string | undefined;
250
+ only_parents?: "true" | "false" | undefined;
251
+ } | undefined): import("../types/api").RequestData<{
252
+ id: string;
253
+ source_ref: {
254
+ id?: string | undefined;
255
+ model?: string | undefined;
256
+ };
257
+ name: string;
258
+ parent_id?: string | undefined;
259
+ }[]>;
260
+ getProducts(params?: {
261
+ location_id?: string | undefined;
262
+ } | undefined): import("../types/api").RequestData<{
263
+ id: string;
264
+ categories: string[];
265
+ name: string;
266
+ description?: string | undefined;
267
+ prices: {
268
+ unit_price: number;
269
+ tax_rate?: number | undefined;
270
+ }[];
271
+ accounting_category_ids?: string[] | undefined;
272
+ }[]>;
273
+ getSales(params: {
274
+ date_from: string;
275
+ date_to: string;
276
+ location_id?: string | undefined;
277
+ }): import("../types/api").RequestData<{
278
+ total: number;
279
+ tax_amount: number;
280
+ taxes?: {
281
+ tax_rate: number;
282
+ tax_amount: number;
283
+ total: number;
284
+ }[] | undefined;
285
+ }>;
286
+ getClosure(date: string, params?: {
287
+ location_id?: string | undefined;
288
+ } | undefined): import("../types/api").RequestData<{
289
+ date: string;
290
+ status: "open" | "closed";
291
+ }>;
292
+ getPayments(params: {
293
+ date_from: string;
294
+ date_to: string;
295
+ }): import("../types/api").RequestData<{
296
+ id?: string | undefined;
297
+ payment_method_id?: string | undefined;
298
+ payment_method_name?: string | undefined;
299
+ total: number;
300
+ tip: number;
301
+ status: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised";
302
+ currency?: string | undefined;
303
+ date?: string | undefined;
304
+ }[]>;
305
+ updateOrder(orderId: string, order: {
306
+ customer_id?: string | undefined;
307
+ }): import("../types/api").RequestData<{
308
+ id: string;
309
+ order_number?: string | undefined;
310
+ creation_date: string;
311
+ closing_date?: string | undefined;
312
+ service_date?: string | undefined;
313
+ device_id?: string | undefined;
314
+ total: number;
315
+ tax_amount: number;
316
+ total_discount: number;
317
+ total_refund: number;
318
+ total_tip: number;
319
+ delivery_fee: number;
320
+ currency?: string | undefined;
321
+ country?: string | undefined;
322
+ loyalty?: number | undefined;
323
+ customer_id?: string | undefined;
324
+ location_id?: string | undefined;
325
+ taxes?: {
326
+ tax_rate: number;
327
+ tax_amount: number;
328
+ total: number;
329
+ }[] | undefined;
330
+ guests?: number | undefined;
331
+ payments: {
332
+ id?: string | undefined;
333
+ payment_method_id?: string | undefined;
334
+ payment_method_name?: string | undefined;
335
+ total: number;
336
+ tip: number;
337
+ status: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised";
338
+ currency?: string | undefined;
339
+ date?: string | undefined;
340
+ }[];
341
+ items: {
342
+ id: string;
343
+ quantity: number;
344
+ unit_price: number;
345
+ total: number;
346
+ tax_amount: number;
347
+ tax_rate?: number | undefined;
348
+ description?: string | undefined;
349
+ discounts: {
350
+ name?: string | undefined;
351
+ total: number;
352
+ }[];
353
+ product_id?: string | undefined;
354
+ accounting_category_id?: string | undefined;
355
+ }[];
356
+ }>;
357
+ getAccountingCategories(params?: {
358
+ location_id?: string | undefined;
359
+ } | undefined): import("../types/api").RequestData<{
360
+ id: string;
361
+ name: string;
362
+ id_parent?: string | undefined;
363
+ code?: string | undefined;
364
+ ledger_account_code?: string | undefined;
365
+ posting_account_code?: string | undefined;
366
+ }[]>;
367
+ }>;
368
+ pms: import("../types/api").ApiFor<{
369
+ getLocations(): import("../types/api").RequestData<{
370
+ id: string;
371
+ name: string;
372
+ timezone?: string | undefined;
373
+ address?: {
374
+ address_type?: string | undefined;
375
+ name?: string | undefined;
376
+ street?: string | undefined;
377
+ number?: string | undefined;
378
+ box?: string | undefined;
379
+ city?: string | undefined;
380
+ postal_code?: string | undefined;
381
+ country?: string | undefined;
382
+ } | undefined;
383
+ }[]>;
384
+ getOrders(params: {
385
+ date_from: string;
386
+ date_to: string;
387
+ location_id?: string | undefined;
388
+ state?: "closed" | "consumed" | undefined;
389
+ }): import("../types/api").RequestData<{
390
+ id: string;
391
+ source_ref: {
392
+ id?: string | undefined;
393
+ model?: string | undefined;
394
+ };
395
+ order_number?: string | undefined;
396
+ creation_date: string;
397
+ closing_date?: string | undefined;
398
+ service_date?: string | undefined;
399
+ device_id?: string | undefined;
400
+ total: number;
401
+ tax_amount: number;
402
+ total_discount: number;
403
+ total_refund: number;
404
+ total_tip: number;
405
+ delivery_fee: number;
406
+ currency?: string | undefined;
407
+ country?: string | undefined;
408
+ loyalty?: number | undefined;
409
+ customer_id?: string | undefined;
410
+ location_id?: string | undefined;
411
+ taxes?: {
412
+ tax_rate: number;
413
+ tax_amount: number;
414
+ total: number;
415
+ }[] | undefined;
416
+ guests?: number | undefined;
417
+ items: {
418
+ id: string;
419
+ source_ref: {
420
+ id?: string | undefined;
421
+ model?: string | undefined;
422
+ };
423
+ quantity: number;
424
+ unit_price: number;
425
+ total: number;
426
+ tax_amount: number;
427
+ tax_rate?: number | undefined;
428
+ description?: string | undefined;
429
+ discounts: {
430
+ name?: string | undefined;
431
+ total: number;
432
+ }[];
433
+ product_id?: string | undefined;
434
+ accounting_category_id?: string | undefined;
435
+ }[];
436
+ service_id?: string | undefined;
437
+ }[]>;
438
+ getPaymentMethods(params?: {
439
+ location_id?: string | undefined;
440
+ } | undefined): import("../types/api").RequestData<{
441
+ id: string;
442
+ source_ref: {
443
+ id?: string | undefined;
444
+ model?: string | undefined;
445
+ };
446
+ name: string;
447
+ extra?: string | undefined;
448
+ ledger_account_code?: string | undefined;
449
+ }[]>;
450
+ getClosure(date: string, params?: {
451
+ location_id?: string | undefined;
452
+ } | undefined): import("../types/api").RequestData<{
453
+ date: string;
454
+ status: "open" | "closed";
455
+ }>;
456
+ getPayments(params: {
457
+ date_from: string;
458
+ date_to: string;
459
+ }): import("../types/api").RequestData<{
460
+ id?: string | undefined;
461
+ source_ref: {
462
+ id?: string | undefined;
463
+ model?: string | undefined;
464
+ };
465
+ payment_method_id?: string | undefined;
466
+ payment_method_name?: string | undefined;
467
+ total: number;
468
+ tip: number;
469
+ status: "Pending" | "Completed" | "Canceled" | "Failed" | "Unknown" | "Authorised";
470
+ currency?: string | undefined;
471
+ date?: string | undefined;
472
+ }[]>;
473
+ getAccountingCategories(params?: {} | undefined): import("../types/api").RequestData<{
474
+ id: string;
475
+ source_ref: {
476
+ id?: string | undefined;
477
+ model?: string | undefined;
478
+ };
479
+ name: string;
480
+ id_parent?: string | undefined;
481
+ code?: string | undefined;
482
+ ledger_account_code?: string | undefined;
483
+ posting_account_code?: string | undefined;
484
+ }[]>;
485
+ }>;
486
+ payment: import("../types/api").ApiFor<{
487
+ getPayments(params: {
488
+ date_from?: string | undefined;
489
+ date_to?: string | undefined;
490
+ }): import("../types/api").RequestData<{
491
+ id: string;
492
+ source_ref: {
493
+ id?: string | undefined;
494
+ model?: string | undefined;
495
+ };
496
+ status: "unknown" | "pending" | "completed" | "canceled" | "failed" | "authorized";
497
+ description: string;
498
+ amount: number;
499
+ currency: string;
500
+ payment_date: string;
501
+ partner_id: string;
502
+ }[]>;
503
+ getBalances(params: {}): import("../types/api").RequestData<{
504
+ id: string;
505
+ source_ref: {
506
+ id?: string | undefined;
507
+ model?: string | undefined;
508
+ };
509
+ available_amount: number;
510
+ currency: string;
511
+ create_date: string;
512
+ }[]>;
513
+ getTransactions(params: {
514
+ date_from?: string | undefined;
515
+ date_to?: string | undefined;
516
+ accounting_category?: "unknown" | "all" | "payout" | "payout_cancel" | "payment" | "payment_cancel" | "fee" | "fee_cancel" | undefined;
517
+ starting_from?: string | undefined;
518
+ balance_id?: string | undefined;
519
+ }): import("../types/api").RequestData<{
520
+ id: string;
521
+ source_ref: {
522
+ id?: string | undefined;
523
+ model?: string | undefined;
524
+ };
525
+ total: number;
526
+ fee: number;
527
+ currency: string;
528
+ exchange_rate: number;
529
+ create_date: string;
530
+ application_type: string;
531
+ accounting_category: "unknown" | "all" | "payout" | "payout_cancel" | "payment" | "payment_cancel" | "fee" | "fee_cancel";
532
+ refund_id?: string | undefined;
533
+ payment_id?: string | undefined;
534
+ }[]>;
535
+ getPayment(params: {
536
+ payment_id: string;
537
+ consumer_id: string;
538
+ }): import("../types/api").RequestData<{
539
+ id: string;
540
+ source_ref: {
541
+ id?: string | undefined;
542
+ model?: string | undefined;
543
+ };
544
+ status: "unknown" | "pending" | "completed" | "canceled" | "failed" | "authorized";
545
+ description: string;
546
+ amount: number;
547
+ currency: string;
548
+ payment_date: string;
549
+ partner_id: string;
550
+ }>;
551
+ getRefunds(params: {
552
+ date_from?: string | undefined;
553
+ date_to?: string | undefined;
554
+ payment_id?: string | undefined;
555
+ }): import("../types/api").RequestData<{
556
+ id: string;
557
+ source_ref: {
558
+ id?: string | undefined;
559
+ model?: string | undefined;
560
+ };
561
+ status: "unknown" | "pending" | "completed" | "canceled" | "failed" | "authorized";
562
+ description: string;
563
+ amount: number;
564
+ currency: string;
565
+ refund_date: string;
566
+ payment_id?: string | undefined;
567
+ }[]>;
568
+ }>;
569
+ accounting: import("../types/api").ApiFor<{
570
+ getAnalyticPlans(params?: {
571
+ folder_id?: string | undefined;
572
+ } | undefined): import("../types/api").RequestData<{
573
+ id: string;
574
+ name: string;
575
+ active: boolean;
576
+ }[]>;
577
+ getClients(params?: {
578
+ folder_id?: string | undefined;
579
+ } | undefined): import("../types/api").RequestData<{
580
+ external_reference?: string | undefined;
581
+ first_name?: string | undefined;
582
+ last_name?: string | undefined;
583
+ name?: string | undefined;
584
+ function?: string | undefined;
585
+ is_company: boolean;
586
+ company_id?: string | undefined;
587
+ phone?: string | undefined;
588
+ mobile?: string | undefined;
589
+ email?: string | undefined;
590
+ language?: string | undefined;
591
+ internal_notes?: string | undefined;
592
+ website?: string | undefined;
593
+ vat?: string | undefined;
594
+ iban?: string | undefined;
595
+ bank_account?: string | undefined;
596
+ currency?: string | undefined;
597
+ active: boolean;
598
+ addresses: {
599
+ address_type: "main" | "delivery" | "invoice";
600
+ name?: string | undefined;
601
+ number?: string | undefined;
602
+ box?: string | undefined;
603
+ phone?: string | undefined;
604
+ mobile?: string | undefined;
605
+ email?: string | undefined;
606
+ street?: string | undefined;
607
+ city?: string | undefined;
608
+ postal_code?: string | undefined;
609
+ country?: string | undefined;
610
+ }[];
611
+ account_number?: string | undefined;
612
+ company_number?: string | undefined;
613
+ id?: string | undefined;
614
+ }[]>;
615
+ createClient(client: {
616
+ external_reference?: string | undefined;
617
+ first_name?: string | undefined;
618
+ last_name?: string | undefined;
619
+ name: string;
620
+ function?: string | undefined;
621
+ is_company: boolean;
622
+ company_id?: string | undefined;
623
+ phone?: string | undefined;
624
+ mobile?: string | undefined;
625
+ email?: string | undefined;
626
+ language?: string | undefined;
627
+ internal_notes?: string | undefined;
628
+ website?: string | undefined;
629
+ vat?: string | undefined;
630
+ iban?: string | undefined;
631
+ bank_account?: string | undefined;
632
+ currency?: string | undefined;
633
+ active: boolean;
634
+ addresses: {
635
+ address_type: "main" | "delivery" | "invoice";
636
+ name?: string | undefined;
637
+ number?: string | undefined;
638
+ box?: string | undefined;
639
+ phone?: string | undefined;
640
+ mobile?: string | undefined;
641
+ email?: string | undefined;
642
+ street: string;
643
+ city: string;
644
+ postal_code: string;
645
+ country: string;
646
+ }[];
647
+ account_number?: string | undefined;
648
+ }, params?: {
649
+ force_merge?: string | undefined;
650
+ folder_id?: string | undefined;
651
+ } | undefined): import("../types/api").RequestData<{
652
+ external_reference?: string | undefined;
653
+ first_name?: string | undefined;
654
+ last_name?: string | undefined;
655
+ name?: string | undefined;
656
+ function?: string | undefined;
657
+ is_company: boolean;
658
+ company_id?: string | undefined;
659
+ phone?: string | undefined;
660
+ mobile?: string | undefined;
661
+ email?: string | undefined;
662
+ language?: string | undefined;
663
+ internal_notes?: string | undefined;
664
+ website?: string | undefined;
665
+ vat?: string | undefined;
666
+ iban?: string | undefined;
667
+ bank_account?: string | undefined;
668
+ currency?: string | undefined;
669
+ active: boolean;
670
+ addresses: {
671
+ address_type: "main" | "delivery" | "invoice";
672
+ name?: string | undefined;
673
+ number?: string | undefined;
674
+ box?: string | undefined;
675
+ phone?: string | undefined;
676
+ mobile?: string | undefined;
677
+ email?: string | undefined;
678
+ street?: string | undefined;
679
+ city?: string | undefined;
680
+ postal_code?: string | undefined;
681
+ country?: string | undefined;
682
+ }[];
683
+ account_number?: string | undefined;
684
+ company_number?: string | undefined;
685
+ id?: string | undefined;
686
+ }>;
687
+ getClient(clientId: string, params?: {
688
+ folder_id?: string | undefined;
689
+ } | undefined): import("../types/api").RequestData<{
690
+ external_reference?: string | undefined;
691
+ first_name?: string | undefined;
692
+ last_name?: string | undefined;
693
+ name?: string | undefined;
694
+ function?: string | undefined;
695
+ is_company: boolean;
696
+ company_id?: string | undefined;
697
+ phone?: string | undefined;
698
+ mobile?: string | undefined;
699
+ email?: string | undefined;
700
+ language?: string | undefined;
701
+ internal_notes?: string | undefined;
702
+ website?: string | undefined;
703
+ vat?: string | undefined;
704
+ iban?: string | undefined;
705
+ bank_account?: string | undefined;
706
+ currency?: string | undefined;
707
+ active: boolean;
708
+ addresses: {
709
+ address_type: "main" | "delivery" | "invoice";
710
+ name?: string | undefined;
711
+ number?: string | undefined;
712
+ box?: string | undefined;
713
+ phone?: string | undefined;
714
+ mobile?: string | undefined;
715
+ email?: string | undefined;
716
+ street?: string | undefined;
717
+ city?: string | undefined;
718
+ postal_code?: string | undefined;
719
+ country?: string | undefined;
720
+ }[];
721
+ account_number?: string | undefined;
722
+ company_number?: string | undefined;
723
+ id?: string | undefined;
724
+ }>;
725
+ updateClient(clientId: string, client: {
726
+ external_reference?: string | undefined;
727
+ first_name?: string | undefined;
728
+ last_name?: string | undefined;
729
+ name?: string | undefined;
730
+ function?: string | undefined;
731
+ is_company: boolean;
732
+ company_id?: string | undefined;
733
+ phone?: string | undefined;
734
+ mobile?: string | undefined;
735
+ email?: string | undefined;
736
+ language?: string | undefined;
737
+ internal_notes?: string | undefined;
738
+ website?: string | undefined;
739
+ vat?: string | undefined;
740
+ iban?: string | undefined;
741
+ bank_account?: string | undefined;
742
+ currency?: string | undefined;
743
+ active: boolean;
744
+ addresses: {
745
+ address_type: "main" | "delivery" | "invoice";
746
+ name?: string | undefined;
747
+ number?: string | undefined;
748
+ box?: string | undefined;
749
+ phone?: string | undefined;
750
+ mobile?: string | undefined;
751
+ email?: string | undefined;
752
+ street?: string | undefined;
753
+ city?: string | undefined;
754
+ postal_code?: string | undefined;
755
+ country?: string | undefined;
756
+ }[];
757
+ }, params?: {
758
+ folder_id?: string | undefined;
759
+ } | undefined): import("../types/api").RequestData<{
760
+ external_reference?: string | undefined;
761
+ first_name?: string | undefined;
762
+ last_name?: string | undefined;
763
+ name?: string | undefined;
764
+ function?: string | undefined;
765
+ is_company: boolean;
766
+ company_id?: string | undefined;
767
+ phone?: string | undefined;
768
+ mobile?: string | undefined;
769
+ email?: string | undefined;
770
+ language?: string | undefined;
771
+ internal_notes?: string | undefined;
772
+ website?: string | undefined;
773
+ vat?: string | undefined;
774
+ iban?: string | undefined;
775
+ bank_account?: string | undefined;
776
+ currency?: string | undefined;
777
+ active: boolean;
778
+ addresses: {
779
+ address_type: "main" | "delivery" | "invoice";
780
+ name?: string | undefined;
781
+ number?: string | undefined;
782
+ box?: string | undefined;
783
+ phone?: string | undefined;
784
+ mobile?: string | undefined;
785
+ email?: string | undefined;
786
+ street?: string | undefined;
787
+ city?: string | undefined;
788
+ postal_code?: string | undefined;
789
+ country?: string | undefined;
790
+ }[];
791
+ account_number?: string | undefined;
792
+ company_number?: string | undefined;
793
+ id?: string | undefined;
794
+ }>;
795
+ getSuppliers(params?: {
796
+ folder_id?: string | undefined;
797
+ } | undefined): import("../types/api").RequestData<{
798
+ external_reference?: string | undefined;
799
+ first_name?: string | undefined;
800
+ last_name?: string | undefined;
801
+ name?: string | undefined;
802
+ function?: string | undefined;
803
+ is_company: boolean;
804
+ company_id?: string | undefined;
805
+ phone?: string | undefined;
806
+ mobile?: string | undefined;
807
+ email?: string | undefined;
808
+ language?: string | undefined;
809
+ internal_notes?: string | undefined;
810
+ website?: string | undefined;
811
+ vat?: string | undefined;
812
+ iban?: string | undefined;
813
+ bank_account?: string | undefined;
814
+ currency?: string | undefined;
815
+ active: boolean;
816
+ addresses: {
817
+ address_type: "main" | "delivery" | "invoice";
818
+ name?: string | undefined;
819
+ number?: string | undefined;
820
+ box?: string | undefined;
821
+ phone?: string | undefined;
822
+ mobile?: string | undefined;
823
+ email?: string | undefined;
824
+ street?: string | undefined;
825
+ city?: string | undefined;
826
+ postal_code?: string | undefined;
827
+ country?: string | undefined;
828
+ }[];
829
+ account_number?: string | undefined;
830
+ company_number?: string | undefined;
831
+ id?: string | undefined;
832
+ }[]>;
833
+ createSupplier(supplier: {
834
+ external_reference?: string | undefined;
835
+ first_name?: string | undefined;
836
+ last_name?: string | undefined;
837
+ name: string;
838
+ function?: string | undefined;
839
+ is_company: boolean;
840
+ company_id?: string | undefined;
841
+ phone?: string | undefined;
842
+ mobile?: string | undefined;
843
+ email?: string | undefined;
844
+ language?: string | undefined;
845
+ internal_notes?: string | undefined;
846
+ website?: string | undefined;
847
+ vat?: string | undefined;
848
+ iban?: string | undefined;
849
+ bank_account?: string | undefined;
850
+ currency?: string | undefined;
851
+ active: boolean;
852
+ addresses: {
853
+ address_type: "main" | "delivery" | "invoice";
854
+ name?: string | undefined;
855
+ number?: string | undefined;
856
+ box?: string | undefined;
857
+ phone?: string | undefined;
858
+ mobile?: string | undefined;
859
+ email?: string | undefined;
860
+ street: string;
861
+ city: string;
862
+ postal_code: string;
863
+ country: string;
864
+ }[];
865
+ account_number?: string | undefined;
866
+ }, params?: {
867
+ force_merge?: string | undefined;
868
+ folder_id?: string | undefined;
869
+ } | undefined): import("../types/api").RequestData<{
870
+ external_reference?: string | undefined;
871
+ first_name?: string | undefined;
872
+ last_name?: string | undefined;
873
+ name?: string | undefined;
874
+ function?: string | undefined;
875
+ is_company: boolean;
876
+ company_id?: string | undefined;
877
+ phone?: string | undefined;
878
+ mobile?: string | undefined;
879
+ email?: string | undefined;
880
+ language?: string | undefined;
881
+ internal_notes?: string | undefined;
882
+ website?: string | undefined;
883
+ vat?: string | undefined;
884
+ iban?: string | undefined;
885
+ bank_account?: string | undefined;
886
+ currency?: string | undefined;
887
+ active: boolean;
888
+ addresses: {
889
+ address_type: "main" | "delivery" | "invoice";
890
+ name?: string | undefined;
891
+ number?: string | undefined;
892
+ box?: string | undefined;
893
+ phone?: string | undefined;
894
+ mobile?: string | undefined;
895
+ email?: string | undefined;
896
+ street?: string | undefined;
897
+ city?: string | undefined;
898
+ postal_code?: string | undefined;
899
+ country?: string | undefined;
900
+ }[];
901
+ account_number?: string | undefined;
902
+ company_number?: string | undefined;
903
+ id?: string | undefined;
904
+ }>;
905
+ getSupplier(supplierId: string, params?: {
906
+ folder_id?: string | undefined;
907
+ } | undefined): import("../types/api").RequestData<{
908
+ external_reference?: string | undefined;
909
+ first_name?: string | undefined;
910
+ last_name?: string | undefined;
911
+ name?: string | undefined;
912
+ function?: string | undefined;
913
+ is_company: boolean;
914
+ company_id?: string | undefined;
915
+ phone?: string | undefined;
916
+ mobile?: string | undefined;
917
+ email?: string | undefined;
918
+ language?: string | undefined;
919
+ internal_notes?: string | undefined;
920
+ website?: string | undefined;
921
+ vat?: string | undefined;
922
+ iban?: string | undefined;
923
+ bank_account?: string | undefined;
924
+ currency?: string | undefined;
925
+ active: boolean;
926
+ addresses: {
927
+ address_type: "main" | "delivery" | "invoice";
928
+ name?: string | undefined;
929
+ number?: string | undefined;
930
+ box?: string | undefined;
931
+ phone?: string | undefined;
932
+ mobile?: string | undefined;
933
+ email?: string | undefined;
934
+ street?: string | undefined;
935
+ city?: string | undefined;
936
+ postal_code?: string | undefined;
937
+ country?: string | undefined;
938
+ }[];
939
+ account_number?: string | undefined;
940
+ company_number?: string | undefined;
941
+ id?: string | undefined;
942
+ }>;
943
+ updateSupplier(supplierId: string, supplier: {
944
+ external_reference?: string | undefined;
945
+ first_name?: string | undefined;
946
+ last_name?: string | undefined;
947
+ name?: string | undefined;
948
+ function?: string | undefined;
949
+ is_company: boolean;
950
+ company_id?: string | undefined;
951
+ phone?: string | undefined;
952
+ mobile?: string | undefined;
953
+ email?: string | undefined;
954
+ language?: string | undefined;
955
+ internal_notes?: string | undefined;
956
+ website?: string | undefined;
957
+ vat?: string | undefined;
958
+ iban?: string | undefined;
959
+ bank_account?: string | undefined;
960
+ currency?: string | undefined;
961
+ active: boolean;
962
+ addresses: {
963
+ address_type: "main" | "delivery" | "invoice";
964
+ name?: string | undefined;
965
+ number?: string | undefined;
966
+ box?: string | undefined;
967
+ phone?: string | undefined;
968
+ mobile?: string | undefined;
969
+ email?: string | undefined;
970
+ street?: string | undefined;
971
+ city?: string | undefined;
972
+ postal_code?: string | undefined;
973
+ country?: string | undefined;
974
+ }[];
975
+ }, params?: {
976
+ folder_id?: string | undefined;
977
+ } | undefined): import("../types/api").RequestData<{
978
+ external_reference?: string | undefined;
979
+ first_name?: string | undefined;
980
+ last_name?: string | undefined;
981
+ name?: string | undefined;
982
+ function?: string | undefined;
983
+ is_company: boolean;
984
+ company_id?: string | undefined;
985
+ phone?: string | undefined;
986
+ mobile?: string | undefined;
987
+ email?: string | undefined;
988
+ language?: string | undefined;
989
+ internal_notes?: string | undefined;
990
+ website?: string | undefined;
991
+ vat?: string | undefined;
992
+ iban?: string | undefined;
993
+ bank_account?: string | undefined;
994
+ currency?: string | undefined;
995
+ active: boolean;
996
+ addresses: {
997
+ address_type: "main" | "delivery" | "invoice";
998
+ name?: string | undefined;
999
+ number?: string | undefined;
1000
+ box?: string | undefined;
1001
+ phone?: string | undefined;
1002
+ mobile?: string | undefined;
1003
+ email?: string | undefined;
1004
+ street?: string | undefined;
1005
+ city?: string | undefined;
1006
+ postal_code?: string | undefined;
1007
+ country?: string | undefined;
1008
+ }[];
1009
+ account_number?: string | undefined;
1010
+ company_number?: string | undefined;
1011
+ id?: string | undefined;
1012
+ }>;
1013
+ createInvoice(invoice: {
1014
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1015
+ invoice_number?: string | undefined;
1016
+ currency: string;
1017
+ untaxed_amount: number;
1018
+ tax_amount: number;
1019
+ total: number;
1020
+ reference?: string | undefined;
1021
+ payment_communication?: string | undefined;
1022
+ customer_memo?: string | undefined;
1023
+ invoice_date: string;
1024
+ due_date: string;
1025
+ partner_id: string;
1026
+ journal_id?: string | undefined;
1027
+ status: "draft" | "posted";
1028
+ pdf?: string | undefined;
1029
+ currency_exchange_rate: number;
1030
+ invoice_correction?: {
1031
+ sale_invoice_correction_tax_code?: string | undefined;
1032
+ purchase_invoice_correction_tax_code?: string | undefined;
1033
+ invoice_correction_credit_account_number?: string | undefined;
1034
+ invoice_correction_debit_account_number?: string | undefined;
1035
+ } | undefined;
1036
+ nl_payment_terms_split?: {
1037
+ g_account: {
1038
+ amount: number;
1039
+ iban: string;
1040
+ };
1041
+ n_account: {
1042
+ amount: number;
1043
+ iban: string;
1044
+ };
1045
+ } | undefined;
1046
+ shipping_country?: string | undefined;
1047
+ lines: {
1048
+ line_number: number;
1049
+ description: string;
1050
+ unit_price: number;
1051
+ unit_of_measure?: string | undefined;
1052
+ quantity: number;
1053
+ untaxed_amount: number;
1054
+ tax_rate: number;
1055
+ tax_amount: number;
1056
+ total: number;
1057
+ account_number: string;
1058
+ tax_code: string;
1059
+ analytic_account?: string | undefined;
1060
+ }[];
1061
+ }, params?: {
1062
+ force_financial_period?: string | undefined;
1063
+ regroup_lines?: "true" | "false" | undefined;
1064
+ folder_id?: string | undefined;
1065
+ } | undefined): import("../types/api").RequestData<{
1066
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1067
+ invoice_number?: string | undefined;
1068
+ currency: string;
1069
+ untaxed_amount: number;
1070
+ tax_amount: number;
1071
+ total: number;
1072
+ reference?: string | undefined;
1073
+ payment_communication?: string | undefined;
1074
+ customer_memo?: string | undefined;
1075
+ id?: string | undefined;
1076
+ invoice_date: string;
1077
+ due_date: string;
1078
+ partner_id: string;
1079
+ journal_id: string;
1080
+ payments?: {
1081
+ id: string;
1082
+ name: string;
1083
+ currency: string;
1084
+ amount: number;
1085
+ dedicated_amount: number;
1086
+ payment_date: string;
1087
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1088
+ journal_id: string;
1089
+ journal_name: string;
1090
+ reconciled: boolean;
1091
+ communication?: string | undefined;
1092
+ matching_number?: string | undefined;
1093
+ }[] | undefined;
1094
+ status: "draft" | "posted" | "cancelled" | "paid";
1095
+ lines: {
1096
+ line_number: number;
1097
+ description: string;
1098
+ unit_price: number;
1099
+ unit_of_measure?: string | undefined;
1100
+ quantity: number;
1101
+ untaxed_amount: number;
1102
+ tax_rate: number;
1103
+ tax_amount: number;
1104
+ total: number;
1105
+ account_number: string;
1106
+ tax_code?: string | undefined;
1107
+ analytic_account?: string | undefined;
1108
+ }[];
1109
+ }>;
1110
+ createInvoiceWithMultiplePlans(invoice: {
1111
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1112
+ invoice_number?: string | undefined;
1113
+ currency: string;
1114
+ untaxed_amount: number;
1115
+ tax_amount: number;
1116
+ total: number;
1117
+ reference?: string | undefined;
1118
+ payment_communication?: string | undefined;
1119
+ customer_memo?: string | undefined;
1120
+ invoice_date: string;
1121
+ due_date: string;
1122
+ partner_id: string;
1123
+ journal_id?: string | undefined;
1124
+ status: "draft" | "posted";
1125
+ pdf?: string | undefined;
1126
+ currency_exchange_rate: number;
1127
+ invoice_correction?: {
1128
+ sale_invoice_correction_tax_code?: string | undefined;
1129
+ purchase_invoice_correction_tax_code?: string | undefined;
1130
+ invoice_correction_credit_account_number?: string | undefined;
1131
+ invoice_correction_debit_account_number?: string | undefined;
1132
+ } | undefined;
1133
+ nl_payment_terms_split?: {
1134
+ g_account: {
1135
+ amount: number;
1136
+ iban: string;
1137
+ };
1138
+ n_account: {
1139
+ amount: number;
1140
+ iban: string;
1141
+ };
1142
+ } | undefined;
1143
+ shipping_country?: string | undefined;
1144
+ lines: {
1145
+ line_number: number;
1146
+ description: string;
1147
+ unit_price: number;
1148
+ unit_of_measure?: string | undefined;
1149
+ quantity: number;
1150
+ untaxed_amount: number;
1151
+ tax_rate: number;
1152
+ tax_amount: number;
1153
+ total: number;
1154
+ account_number: string;
1155
+ tax_code: string;
1156
+ analytic_distribution: {
1157
+ analytic_plan: string;
1158
+ analytic_accounts: {
1159
+ analytic_account: string;
1160
+ percentage: number;
1161
+ }[];
1162
+ }[];
1163
+ }[];
1164
+ }, params?: {
1165
+ force_financial_period?: string | undefined;
1166
+ regroup_lines?: "true" | "false" | undefined;
1167
+ folder_id?: string | undefined;
1168
+ } | undefined): import("../types/api").RequestData<{
1169
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1170
+ invoice_number?: string | undefined;
1171
+ currency: string;
1172
+ untaxed_amount: number;
1173
+ tax_amount: number;
1174
+ total: number;
1175
+ reference?: string | undefined;
1176
+ payment_communication?: string | undefined;
1177
+ customer_memo?: string | undefined;
1178
+ id?: string | undefined;
1179
+ invoice_date: string;
1180
+ due_date: string;
1181
+ partner_id: string;
1182
+ journal_id: string;
1183
+ payments?: {
1184
+ id: string;
1185
+ name: string;
1186
+ currency: string;
1187
+ amount: number;
1188
+ dedicated_amount: number;
1189
+ payment_date: string;
1190
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1191
+ journal_id: string;
1192
+ journal_name: string;
1193
+ reconciled: boolean;
1194
+ communication?: string | undefined;
1195
+ matching_number?: string | undefined;
1196
+ }[] | undefined;
1197
+ status: "draft" | "posted" | "cancelled" | "paid";
1198
+ lines: {
1199
+ line_number: number;
1200
+ description: string;
1201
+ unit_price: number;
1202
+ unit_of_measure?: string | undefined;
1203
+ quantity: number;
1204
+ untaxed_amount: number;
1205
+ tax_rate: number;
1206
+ tax_amount: number;
1207
+ total: number;
1208
+ account_number: string;
1209
+ tax_code?: string | undefined;
1210
+ analytic_distribution: {
1211
+ analytic_plan: string;
1212
+ analytic_accounts: {
1213
+ analytic_account: string;
1214
+ percentage: number;
1215
+ }[];
1216
+ }[];
1217
+ }[];
1218
+ }>;
1219
+ getInvoicesByType(invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund", params?: {
1220
+ date_from?: string | undefined;
1221
+ date_to?: string | undefined;
1222
+ folder_id?: string | undefined;
1223
+ journal_ids?: string | undefined;
1224
+ include_payments?: "true" | "false" | undefined;
1225
+ payment_status?: "all" | "paid" | "unpaid" | undefined;
1226
+ } | undefined): import("../types/api").RequestData<{
1227
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1228
+ invoice_number?: string | undefined;
1229
+ currency: string;
1230
+ untaxed_amount: number;
1231
+ tax_amount: number;
1232
+ total: number;
1233
+ reference?: string | undefined;
1234
+ payment_communication?: string | undefined;
1235
+ customer_memo?: string | undefined;
1236
+ id?: string | undefined;
1237
+ invoice_date: string;
1238
+ due_date: string;
1239
+ partner_id: string;
1240
+ journal_id: string;
1241
+ payments?: {
1242
+ id: string;
1243
+ name: string;
1244
+ currency: string;
1245
+ amount: number;
1246
+ dedicated_amount: number;
1247
+ payment_date: string;
1248
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1249
+ journal_id: string;
1250
+ journal_name: string;
1251
+ reconciled: boolean;
1252
+ communication?: string | undefined;
1253
+ matching_number?: string | undefined;
1254
+ }[] | undefined;
1255
+ status: "draft" | "posted" | "cancelled" | "paid";
1256
+ lines: {
1257
+ line_number: number;
1258
+ description: string;
1259
+ unit_price: number;
1260
+ unit_of_measure?: string | undefined;
1261
+ quantity: number;
1262
+ untaxed_amount: number;
1263
+ tax_rate: number;
1264
+ tax_amount: number;
1265
+ total: number;
1266
+ account_number: string;
1267
+ tax_code?: string | undefined;
1268
+ analytic_account?: string | undefined;
1269
+ }[];
1270
+ }[]>;
1271
+ getInvoice(invoiceId: string, params?: {
1272
+ include_payments?: "true" | "false" | undefined;
1273
+ folder_id?: string | undefined;
1274
+ } | undefined): import("../types/api").RequestData<{
1275
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1276
+ invoice_number?: string | undefined;
1277
+ currency: string;
1278
+ untaxed_amount: number;
1279
+ tax_amount: number;
1280
+ total: number;
1281
+ reference?: string | undefined;
1282
+ payment_communication?: string | undefined;
1283
+ customer_memo?: string | undefined;
1284
+ id?: string | undefined;
1285
+ invoice_date: string;
1286
+ due_date: string;
1287
+ partner_id: string;
1288
+ journal_id: string;
1289
+ payments?: {
1290
+ id: string;
1291
+ name: string;
1292
+ currency: string;
1293
+ amount: number;
1294
+ dedicated_amount: number;
1295
+ payment_date: string;
1296
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1297
+ journal_id: string;
1298
+ journal_name: string;
1299
+ reconciled: boolean;
1300
+ communication?: string | undefined;
1301
+ matching_number?: string | undefined;
1302
+ }[] | undefined;
1303
+ status: "draft" | "posted" | "cancelled" | "paid";
1304
+ lines: {
1305
+ line_number: number;
1306
+ description: string;
1307
+ unit_price: number;
1308
+ unit_of_measure?: string | undefined;
1309
+ quantity: number;
1310
+ untaxed_amount: number;
1311
+ tax_rate: number;
1312
+ tax_amount: number;
1313
+ total: number;
1314
+ account_number: string;
1315
+ tax_code?: string | undefined;
1316
+ analytic_account?: string | undefined;
1317
+ }[];
1318
+ }>;
1319
+ getInvoiceWithMultiplePlans(invoiceId: string, params?: {
1320
+ include_payments?: "true" | "false" | undefined;
1321
+ folder_id?: string | undefined;
1322
+ } | undefined): import("../types/api").RequestData<{
1323
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1324
+ invoice_number?: string | undefined;
1325
+ currency: string;
1326
+ untaxed_amount: number;
1327
+ tax_amount: number;
1328
+ total: number;
1329
+ reference?: string | undefined;
1330
+ payment_communication?: string | undefined;
1331
+ customer_memo?: string | undefined;
1332
+ id?: string | undefined;
1333
+ invoice_date: string;
1334
+ due_date: string;
1335
+ partner_id: string;
1336
+ journal_id: string;
1337
+ payments?: {
1338
+ id: string;
1339
+ name: string;
1340
+ currency: string;
1341
+ amount: number;
1342
+ dedicated_amount: number;
1343
+ payment_date: string;
1344
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1345
+ journal_id: string;
1346
+ journal_name: string;
1347
+ reconciled: boolean;
1348
+ communication?: string | undefined;
1349
+ matching_number?: string | undefined;
1350
+ }[] | undefined;
1351
+ status: "draft" | "posted" | "cancelled" | "paid";
1352
+ lines: {
1353
+ line_number: number;
1354
+ description: string;
1355
+ unit_price: number;
1356
+ unit_of_measure?: string | undefined;
1357
+ quantity: number;
1358
+ untaxed_amount: number;
1359
+ tax_rate: number;
1360
+ tax_amount: number;
1361
+ total: number;
1362
+ account_number: string;
1363
+ tax_code?: string | undefined;
1364
+ analytic_distribution: {
1365
+ analytic_plan: string;
1366
+ analytic_accounts: {
1367
+ analytic_account: string;
1368
+ percentage: number;
1369
+ }[];
1370
+ }[];
1371
+ }[];
1372
+ }>;
1373
+ getInvoicesByTypeWithMultiplePlans(invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund", params?: {
1374
+ date_from?: string | undefined;
1375
+ date_to?: string | undefined;
1376
+ folder_id?: string | undefined;
1377
+ journal_ids?: string | undefined;
1378
+ include_payments?: "true" | "false" | undefined;
1379
+ payment_status?: "all" | "paid" | "unpaid" | undefined;
1380
+ } | undefined): import("../types/api").RequestData<{
1381
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
1382
+ invoice_number?: string | undefined;
1383
+ currency: string;
1384
+ untaxed_amount: number;
1385
+ tax_amount: number;
1386
+ total: number;
1387
+ reference?: string | undefined;
1388
+ payment_communication?: string | undefined;
1389
+ customer_memo?: string | undefined;
1390
+ id?: string | undefined;
1391
+ invoice_date: string;
1392
+ due_date: string;
1393
+ partner_id: string;
1394
+ journal_id: string;
1395
+ payments?: {
1396
+ id: string;
1397
+ name: string;
1398
+ currency: string;
1399
+ amount: number;
1400
+ dedicated_amount: number;
1401
+ payment_date: string;
1402
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1403
+ journal_id: string;
1404
+ journal_name: string;
1405
+ reconciled: boolean;
1406
+ communication?: string | undefined;
1407
+ matching_number?: string | undefined;
1408
+ }[] | undefined;
1409
+ status: "draft" | "posted" | "cancelled" | "paid";
1410
+ lines: {
1411
+ line_number: number;
1412
+ description: string;
1413
+ unit_price: number;
1414
+ unit_of_measure?: string | undefined;
1415
+ quantity: number;
1416
+ untaxed_amount: number;
1417
+ tax_rate: number;
1418
+ tax_amount: number;
1419
+ total: number;
1420
+ account_number: string;
1421
+ tax_code?: string | undefined;
1422
+ analytic_distribution: {
1423
+ analytic_plan: string;
1424
+ analytic_accounts: {
1425
+ analytic_account: string;
1426
+ percentage: number;
1427
+ }[];
1428
+ }[];
1429
+ }[];
1430
+ }[]>;
1431
+ createAnalyticAccount(analyticAccount: {
1432
+ active: boolean;
1433
+ code: string;
1434
+ name: string;
1435
+ currency: string;
1436
+ }, params?: {
1437
+ folder_id?: string | undefined;
1438
+ } | undefined): import("../types/api").RequestData<{
1439
+ id: string;
1440
+ active: boolean;
1441
+ code?: string | undefined;
1442
+ name: string;
1443
+ currency?: string | undefined;
1444
+ balance: number;
1445
+ credit: number;
1446
+ debit: number;
1447
+ }>;
1448
+ getAnalyticAccounts(params?: {
1449
+ folder_id?: string | undefined;
1450
+ } | undefined): import("../types/api").RequestData<{
1451
+ id: string;
1452
+ active: boolean;
1453
+ code?: string | undefined;
1454
+ name: string;
1455
+ currency?: string | undefined;
1456
+ balance: number;
1457
+ credit: number;
1458
+ debit: number;
1459
+ }[]>;
1460
+ createAnalyticAccountWithMultiplePlans(analytic_plan: string, analyticAccount: {
1461
+ active: boolean;
1462
+ code: string;
1463
+ name: string;
1464
+ currency: string;
1465
+ }, params?: {
1466
+ folder_id?: string | undefined;
1467
+ } | undefined): import("../types/api").RequestData<{
1468
+ id: string;
1469
+ active: boolean;
1470
+ code?: string | undefined;
1471
+ name: string;
1472
+ currency?: string | undefined;
1473
+ balance: number;
1474
+ credit: number;
1475
+ debit: number;
1476
+ analytic_plan: string;
1477
+ }>;
1478
+ getAnalyticAccount(analytic_account_id: string, params?: {
1479
+ folder_id?: string | undefined;
1480
+ } | undefined): import("../types/api").RequestData<{
1481
+ id: string;
1482
+ active: boolean;
1483
+ code?: string | undefined;
1484
+ name: string;
1485
+ currency?: string | undefined;
1486
+ balance: number;
1487
+ credit: number;
1488
+ debit: number;
1489
+ }>;
1490
+ updateAnalyticAccount(analytic_account_id: string, analyticAccount: {
1491
+ active: boolean;
1492
+ code?: string | undefined;
1493
+ name?: string | undefined;
1494
+ currency?: string | undefined;
1495
+ }, params?: {
1496
+ folder_id?: string | undefined;
1497
+ } | undefined): import("../types/api").RequestData<{
1498
+ id: string;
1499
+ active: boolean;
1500
+ code?: string | undefined;
1501
+ name: string;
1502
+ currency?: string | undefined;
1503
+ balance: number;
1504
+ credit: number;
1505
+ debit: number;
1506
+ }>;
1507
+ getAnalyticAccountWithMultiplePlans(analytic_account_id: string, analytic_plan: string, params?: {
1508
+ folder_id?: string | undefined;
1509
+ } | undefined): import("../types/api").RequestData<{
1510
+ id: string;
1511
+ active: boolean;
1512
+ code?: string | undefined;
1513
+ name: string;
1514
+ currency?: string | undefined;
1515
+ balance: number;
1516
+ credit: number;
1517
+ debit: number;
1518
+ analytic_plan: string;
1519
+ }>;
1520
+ updateAnalyticAccountWithMultiplePlans(analytic_account_id: string, analytic_plan: string, analyticAccount: {
1521
+ active: boolean;
1522
+ code?: string | undefined;
1523
+ name?: string | undefined;
1524
+ currency?: string | undefined;
1525
+ }, params?: {
1526
+ folder_id?: string | undefined;
1527
+ } | undefined): import("../types/api").RequestData<{
1528
+ id: string;
1529
+ active: boolean;
1530
+ code?: string | undefined;
1531
+ name: string;
1532
+ currency?: string | undefined;
1533
+ balance: number;
1534
+ credit: number;
1535
+ debit: number;
1536
+ analytic_plan: string;
1537
+ }>;
1538
+ getAnalyticAccountsWithMultiplePlans(params?: {
1539
+ folder_id?: string | undefined;
1540
+ } | undefined): import("../types/api").RequestData<{
1541
+ id: string;
1542
+ active: boolean;
1543
+ code?: string | undefined;
1544
+ name: string;
1545
+ currency?: string | undefined;
1546
+ balance: number;
1547
+ credit: number;
1548
+ debit: number;
1549
+ analytic_plan: string;
1550
+ }[]>;
1551
+ getJournalEntries(params: {
1552
+ date_from: string;
1553
+ date_to: string;
1554
+ folder_id?: string | undefined;
1555
+ unposted_allowed: "true" | "false";
1556
+ journal_id: string;
1557
+ partner_id?: string | undefined;
1558
+ }): import("../types/api").RequestData<{
1559
+ reference?: string | undefined;
1560
+ due_date?: string | undefined;
1561
+ journal_id: string;
1562
+ name?: string | undefined;
1563
+ journal_name: string;
1564
+ date: string;
1565
+ posted: boolean;
1566
+ id: string;
1567
+ items: {
1568
+ account_number: string;
1569
+ partner_id?: string | undefined;
1570
+ description?: string | undefined;
1571
+ debit: number;
1572
+ credit: number;
1573
+ currency: string;
1574
+ currency_exchange_rate: number;
1575
+ id: string;
1576
+ partner_name?: string | undefined;
1577
+ account_name: string;
1578
+ matching_numbers: string[];
1579
+ analytic_account?: string | undefined;
1580
+ analytic_account_name?: string | undefined;
1581
+ }[];
1582
+ }[]>;
1583
+ getJournalEntriesWithMultiplePlans(params: {
1584
+ date_from: string;
1585
+ date_to: string;
1586
+ folder_id?: string | undefined;
1587
+ unposted_allowed: "true" | "false";
1588
+ journal_id: string;
1589
+ partner_id?: string | undefined;
1590
+ }): import("../types/api").RequestData<{
1591
+ reference?: string | undefined;
1592
+ due_date?: string | undefined;
1593
+ journal_id: string;
1594
+ name?: string | undefined;
1595
+ journal_name: string;
1596
+ date: string;
1597
+ posted: boolean;
1598
+ id: string;
1599
+ items: {
1600
+ account_number: string;
1601
+ partner_id?: string | undefined;
1602
+ description?: string | undefined;
1603
+ debit: number;
1604
+ credit: number;
1605
+ currency: string;
1606
+ currency_exchange_rate: number;
1607
+ id: string;
1608
+ partner_name?: string | undefined;
1609
+ account_name: string;
1610
+ matching_numbers: string[];
1611
+ analytic_distribution: {
1612
+ analytic_plan: string;
1613
+ analytic_accounts: {
1614
+ analytic_account: string;
1615
+ percentage: number;
1616
+ }[];
1617
+ }[];
1618
+ }[];
1619
+ }[]>;
1620
+ getPaymentsByInvoiceId(invoice_id: string, params?: {
1621
+ folder_id?: string | undefined;
1622
+ page?: number | undefined;
1623
+ size?: number | undefined;
1624
+ } | undefined): import("../types/api").RequestData<{
1625
+ id: string;
1626
+ name: string;
1627
+ currency: string;
1628
+ amount: number;
1629
+ dedicated_amount: number;
1630
+ payment_date: string;
1631
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1632
+ journal_id: string;
1633
+ journal_name: string;
1634
+ reconciled: boolean;
1635
+ communication?: string | undefined;
1636
+ matching_number?: string | undefined;
1637
+ }[]>;
1638
+ getJournals(params?: {
1639
+ folder_id?: string | undefined;
1640
+ } | undefined): import("../types/api").RequestData<{
1641
+ id: string;
1642
+ code?: string | undefined;
1643
+ name: string;
1644
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1645
+ counterpart_account?: string | undefined;
1646
+ next_document_numbers: {
1647
+ bookyear_name?: string | undefined;
1648
+ next_document_number?: string | undefined;
1649
+ start_date?: string | undefined;
1650
+ end_date?: string | undefined;
1651
+ }[];
1652
+ }[]>;
1653
+ getVatCodes(params?: {
1654
+ folder_id?: string | undefined;
1655
+ } | undefined): import("../types/api").RequestData<{
1656
+ id: string;
1657
+ code?: string | undefined;
1658
+ label: string;
1659
+ scope: "unknown" | "nat" | "eu" | "int";
1660
+ rate: number;
1661
+ type: "unknown" | "sale" | "purchase" | "both";
1662
+ deductible_account?: string | undefined;
1663
+ payable_account?: string | undefined;
1664
+ }[]>;
1665
+ getMiscOperations(params?: {
1666
+ date_from?: string | undefined;
1667
+ date_to?: string | undefined;
1668
+ folder_id?: string | undefined;
1669
+ journal_ids?: string | undefined;
1670
+ } | undefined): import("../types/api").RequestData<{
1671
+ operation_number?: string | undefined;
1672
+ currency: string;
1673
+ currency_exchange_rate: number;
1674
+ lines: {
1675
+ line_number: number;
1676
+ description?: string | undefined;
1677
+ amount: number;
1678
+ type: "customer_account" | "general_account" | "supplier_account";
1679
+ account_number: string;
1680
+ partner_id?: string | undefined;
1681
+ analytic_account?: string | undefined;
1682
+ }[];
1683
+ operation_date: string;
1684
+ journal_id: string;
1685
+ status: "draft" | "posted" | "cancelled" | "matched";
1686
+ id: string;
1687
+ }[]>;
1688
+ createMiscOperation(operation: {
1689
+ operation_number?: string | undefined;
1690
+ currency: string;
1691
+ currency_exchange_rate: number;
1692
+ lines: {
1693
+ line_number: number;
1694
+ description?: string | undefined;
1695
+ amount: number;
1696
+ type: "customer_account" | "general_account" | "supplier_account";
1697
+ account_number: string;
1698
+ partner_id?: string | undefined;
1699
+ analytic_account?: string | undefined;
1700
+ }[];
1701
+ operation_date: string;
1702
+ journal_id?: string | undefined;
1703
+ status: "draft" | "posted";
1704
+ }, params?: {
1705
+ folder_id?: string | undefined;
1706
+ } | undefined): import("../types/api").RequestData<{
1707
+ operation_number?: string | undefined;
1708
+ currency: string;
1709
+ currency_exchange_rate: number;
1710
+ lines: {
1711
+ line_number: number;
1712
+ description?: string | undefined;
1713
+ amount: number;
1714
+ type: "customer_account" | "general_account" | "supplier_account";
1715
+ account_number: string;
1716
+ partner_id?: string | undefined;
1717
+ analytic_account?: string | undefined;
1718
+ }[];
1719
+ operation_date: string;
1720
+ journal_id: string;
1721
+ status: "draft" | "posted" | "cancelled" | "matched";
1722
+ id: string;
1723
+ }>;
1724
+ getMiscOperation(operation_id: string, params?: {
1725
+ folder_id?: string | undefined;
1726
+ } | undefined): import("../types/api").RequestData<{
1727
+ operation_number?: string | undefined;
1728
+ currency: string;
1729
+ currency_exchange_rate: number;
1730
+ lines: {
1731
+ line_number: number;
1732
+ description?: string | undefined;
1733
+ amount: number;
1734
+ type: "customer_account" | "general_account" | "supplier_account";
1735
+ account_number: string;
1736
+ partner_id?: string | undefined;
1737
+ analytic_account?: string | undefined;
1738
+ }[];
1739
+ operation_date: string;
1740
+ journal_id: string;
1741
+ status: "draft" | "posted" | "cancelled" | "matched";
1742
+ id: string;
1743
+ }>;
1744
+ attachPDF(invoice_id: string, attachment: {
1745
+ base64_string: string;
1746
+ }, params?: {
1747
+ overwrite_existing?: "true" | "false" | undefined;
1748
+ folder_id?: string | undefined;
1749
+ } | undefined): import("../types/api").RequestData<{
1750
+ headers: {
1751
+ [name: string]: unknown;
1752
+ };
1753
+ content: {
1754
+ 'application/json': unknown;
1755
+ };
1756
+ }>;
1757
+ getAttachments(params: {
1758
+ folder_id?: string | undefined;
1759
+ type: "invoice" | "entry";
1760
+ document_id: string;
1761
+ }): import("../types/api").RequestData<{
1762
+ base64_string: string;
1763
+ }[]>;
1764
+ getChartOfAccounts(params?: {
1765
+ classes?: string | undefined;
1766
+ folder_id?: string | undefined;
1767
+ } | undefined): import("../types/api").RequestData<{
1768
+ number: string;
1769
+ name: string;
1770
+ active: boolean;
1771
+ type?: "vat" | "bank" | "cash" | "other_financial" | "receivable" | "payable" | "income" | "expense" | "other" | undefined;
1772
+ }[]>;
1773
+ getBalanceOfAccounts(filter: {
1774
+ accounts: string[];
1775
+ start?: string | undefined;
1776
+ end: string;
1777
+ }, params?: {
1778
+ folder_id?: string | undefined;
1779
+ } | undefined): import("../types/api").RequestData<{
1780
+ account_number: string;
1781
+ account_name?: string | undefined;
1782
+ debit: number;
1783
+ credit: number;
1784
+ balance: number;
1785
+ period_debit: number;
1786
+ period_credit: number;
1787
+ period_balance: number;
1788
+ }[]>;
1789
+ getEmployees(params?: {
1790
+ folder_id?: string | undefined;
1791
+ } | undefined): import("../types/api").RequestData<{
1792
+ id: string;
1793
+ name: string;
1794
+ first_name?: string | undefined;
1795
+ last_name?: string | undefined;
1796
+ function?: string | undefined;
1797
+ phone?: string | undefined;
1798
+ mobile?: string | undefined;
1799
+ email?: string | undefined;
1800
+ active: boolean;
1801
+ reference?: string | undefined;
1802
+ account_number?: string | undefined;
1803
+ }[]>;
1804
+ getOutstandings(params: {
1805
+ folder_id?: string | undefined;
1806
+ type: "client" | "supplier";
1807
+ unposted_allowed: "true" | "false";
1808
+ }): import("../types/api").RequestData<{
1809
+ id: string;
1810
+ number?: string | undefined;
1811
+ journal_id: string;
1812
+ journal_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "financial_operation" | "miscellaneous_operation" | "unknown";
1813
+ date: string;
1814
+ due_date?: string | undefined;
1815
+ currency: string;
1816
+ currency_exchange_rate: number;
1817
+ amount: number;
1818
+ open_amount: number;
1819
+ partner_id: string;
1820
+ account_number: string;
1821
+ reference?: string | undefined;
1822
+ payment_communication?: string | undefined;
1823
+ posted: boolean;
1824
+ }[]>;
1825
+ createFinancialEntryOld(financial_entry: {
1826
+ date: string;
1827
+ journal_id: string;
1828
+ currency: string;
1829
+ currency_exchange_rate: number;
1830
+ reference?: string | undefined;
1831
+ number?: string | undefined;
1832
+ items: {
1833
+ type: "customer_account" | "general_account" | "supplier_account" | "employee_account";
1834
+ account_number: string;
1835
+ partner_id?: string | undefined;
1836
+ amount: number;
1837
+ description?: string | undefined;
1838
+ }[];
1839
+ pdf?: string | undefined;
1840
+ }, params?: {
1841
+ financial_counterpart_account?: string | undefined;
1842
+ folder_id?: string | undefined;
1843
+ } | undefined): import("../types/api").RequestData<{
1844
+ date: string;
1845
+ journal_id: string;
1846
+ currency: string;
1847
+ currency_exchange_rate: number;
1848
+ reference?: string | undefined;
1849
+ id: string;
1850
+ number: string;
1851
+ items: {
1852
+ type: "customer_account" | "general_account" | "supplier_account" | "employee_account";
1853
+ account_number: string;
1854
+ partner_id?: string | undefined;
1855
+ amount: number;
1856
+ description?: string | undefined;
1857
+ counterpart_account: string;
1858
+ }[];
1859
+ }>;
1860
+ createFinancialEntry(financial_entry: {
1861
+ date: string;
1862
+ journal_id: string;
1863
+ currency: string;
1864
+ currency_exchange_rate: number;
1865
+ reference?: string | undefined;
1866
+ number?: string | undefined;
1867
+ items: {
1868
+ account_type: "customer_account" | "general_account" | "supplier_account" | "employee_account";
1869
+ account: string;
1870
+ amount: number;
1871
+ description?: string | undefined;
1872
+ }[];
1873
+ pdf?: string | undefined;
1874
+ }, params?: {
1875
+ financial_counterpart_account?: string | undefined;
1876
+ folder_id?: string | undefined;
1877
+ } | undefined): import("../types/api").RequestData<{
1878
+ date: string;
1879
+ journal_id: string;
1880
+ currency: string;
1881
+ currency_exchange_rate: number;
1882
+ reference?: string | undefined;
1883
+ id: string;
1884
+ number: string;
1885
+ items: {
1886
+ account_type: "customer_account" | "general_account" | "supplier_account" | "employee_account";
1887
+ account: string;
1888
+ amount: number;
1889
+ description?: string | undefined;
1890
+ counterpart_account: string;
1891
+ }[];
1892
+ }[]>;
1893
+ createJournalEntryOld(journal_entry: {
1894
+ reference?: string | undefined;
1895
+ due_date?: string | undefined;
1896
+ journal_id: string;
1897
+ name: string;
1898
+ date: string;
1899
+ items: {
1900
+ account_number: string;
1901
+ partner_id?: string | undefined;
1902
+ description?: string | undefined;
1903
+ debit: number;
1904
+ credit: number;
1905
+ currency: string;
1906
+ currency_exchange_rate: number;
1907
+ analytic_distribution: {
1908
+ analytic_plan: string;
1909
+ analytic_accounts: {
1910
+ analytic_account: string;
1911
+ percentage: number;
1912
+ }[];
1913
+ }[];
1914
+ }[];
1915
+ pdf?: string | undefined;
1916
+ }): import("../types/api").RequestData<{
1917
+ reference?: string | undefined;
1918
+ due_date?: string | undefined;
1919
+ journal_id: string;
1920
+ name?: string | undefined;
1921
+ journal_name: string;
1922
+ date: string;
1923
+ posted: boolean;
1924
+ id: string;
1925
+ items: {
1926
+ account_number: string;
1927
+ partner_id?: string | undefined;
1928
+ description?: string | undefined;
1929
+ debit: number;
1930
+ credit: number;
1931
+ currency: string;
1932
+ currency_exchange_rate: number;
1933
+ id: string;
1934
+ partner_name?: string | undefined;
1935
+ account_name: string;
1936
+ matching_numbers: string[];
1937
+ analytic_distribution: {
1938
+ analytic_plan: string;
1939
+ analytic_accounts: {
1940
+ analytic_account: string;
1941
+ percentage: number;
1942
+ }[];
1943
+ }[];
1944
+ }[];
1945
+ }>;
1946
+ createJournalEntry(journal_entry: {
1947
+ reference?: string | undefined;
1948
+ due_date?: string | undefined;
1949
+ journal_id: string;
1950
+ number: string;
1951
+ currency: string;
1952
+ currency_exchange_rate: number;
1953
+ date: string;
1954
+ items: {
1955
+ account_type: "customer_account" | "general_account" | "supplier_account" | "employee_account";
1956
+ account: string;
1957
+ force_general_account?: string | undefined;
1958
+ prioritise_thirdparty_account: boolean;
1959
+ description?: string | undefined;
1960
+ debit: number;
1961
+ credit: number;
1962
+ analytic_distribution: {
1963
+ analytic_plan: string;
1964
+ analytic_accounts: {
1965
+ analytic_account: string;
1966
+ percentage: number;
1967
+ }[];
1968
+ }[];
1969
+ tax_code?: string | undefined;
1970
+ }[];
1971
+ pdf?: string | undefined;
1972
+ posted: boolean;
1973
+ }, params?: {
1974
+ force_currency_exchange?: "true" | "false" | undefined;
1975
+ folder_id?: string | undefined;
1976
+ } | undefined): import("../types/api").RequestData<{
1977
+ reference?: string | undefined;
1978
+ due_date?: string | undefined;
1979
+ journal_id: string;
1980
+ name?: string | undefined;
1981
+ journal_name: string;
1982
+ date: string;
1983
+ posted: boolean;
1984
+ id: string;
1985
+ items: {
1986
+ account_number: string;
1987
+ partner_id?: string | undefined;
1988
+ description?: string | undefined;
1989
+ debit: number;
1990
+ credit: number;
1991
+ currency: string;
1992
+ currency_exchange_rate: number;
1993
+ id: string;
1994
+ partner_name?: string | undefined;
1995
+ account_name: string;
1996
+ matching_numbers: string[];
1997
+ analytic_distribution: {
1998
+ analytic_plan: string;
1999
+ analytic_accounts: {
2000
+ analytic_account: string;
2001
+ percentage: number;
2002
+ }[];
2003
+ }[];
2004
+ }[];
2005
+ }>;
2006
+ matchEntries(body: {
2007
+ entries: string[];
2008
+ partner_id: string;
2009
+ }, params?: {
2010
+ folder_id?: string | undefined;
2011
+ } | undefined): import("../types/api").RequestData<{
2012
+ matching_number: string;
2013
+ balance: number;
2014
+ }>;
2015
+ getFolders(): import("../types/api").RequestData<{
2016
+ id: string;
2017
+ name: string;
2018
+ selected: boolean;
2019
+ vat?: string | undefined;
2020
+ company_number?: string | undefined;
2021
+ }[]>;
2022
+ }>;
2023
+ invoicing: import("../types/api").ApiFor<{
2024
+ getInvoices(params?: {
2025
+ date_from?: string | undefined;
2026
+ date_to?: string | undefined;
2027
+ payment_status?: "all" | "paid" | "unpaid" | undefined;
2028
+ invoice_type?: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund" | "all" | undefined;
2029
+ updated_after?: string | undefined;
2030
+ } | undefined): import("../types/api").RequestData<{
2031
+ id: string;
2032
+ source_ref: {
2033
+ id?: string | undefined;
2034
+ model?: string | undefined;
2035
+ };
2036
+ currency: string;
2037
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
2038
+ status: "draft" | "posted" | "cancelled" | "paid";
2039
+ invoice_date: string;
2040
+ tax_amount: number;
2041
+ untaxed_amount: number;
2042
+ total: number;
2043
+ lines: {
2044
+ description?: string | undefined;
2045
+ unit_price: number;
2046
+ quantity: number;
2047
+ discount_amount: number;
2048
+ tax_amount: number;
2049
+ untaxed_amount: number;
2050
+ total: number;
2051
+ tax_rate?: number | undefined;
2052
+ account_number?: string | undefined;
2053
+ tax_id?: string | undefined;
2054
+ unit_of_measure?: string | undefined;
2055
+ product_id?: string | undefined;
2056
+ product_code?: string | undefined;
2057
+ product_name?: string | undefined;
2058
+ }[];
2059
+ partner_id?: string | undefined;
2060
+ invoice_number?: string | undefined;
2061
+ due_date?: string | undefined;
2062
+ reference?: string | undefined;
2063
+ payment_communication?: string | undefined;
2064
+ customer_memo?: string | undefined;
2065
+ journal_ref?: {
2066
+ id?: string | undefined;
2067
+ model?: string | undefined;
2068
+ name?: string | undefined;
2069
+ } | undefined;
2070
+ last_updated_on?: string | undefined;
2071
+ outstanding_amount?: number | undefined;
2072
+ }[]>;
2073
+ getInvoiceById(invoiceId: string, params?: {
2074
+ include_pdf?: "true" | "false" | undefined;
2075
+ } | undefined): import("../types/api").RequestData<{
2076
+ id: string;
2077
+ source_ref: {
2078
+ id?: string | undefined;
2079
+ model?: string | undefined;
2080
+ };
2081
+ currency: string;
2082
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
2083
+ status: "draft" | "posted" | "cancelled" | "paid";
2084
+ invoice_date: string;
2085
+ tax_amount: number;
2086
+ untaxed_amount: number;
2087
+ total: number;
2088
+ lines: {
2089
+ description?: string | undefined;
2090
+ unit_price: number;
2091
+ quantity: number;
2092
+ discount_amount: number;
2093
+ tax_amount: number;
2094
+ untaxed_amount: number;
2095
+ total: number;
2096
+ tax_rate?: number | undefined;
2097
+ account_number?: string | undefined;
2098
+ tax_id?: string | undefined;
2099
+ unit_of_measure?: string | undefined;
2100
+ product_id?: string | undefined;
2101
+ product_code?: string | undefined;
2102
+ product_name?: string | undefined;
2103
+ }[];
2104
+ partner_id?: string | undefined;
2105
+ invoice_number?: string | undefined;
2106
+ due_date?: string | undefined;
2107
+ reference?: string | undefined;
2108
+ payment_communication?: string | undefined;
2109
+ customer_memo?: string | undefined;
2110
+ journal_ref?: {
2111
+ id?: string | undefined;
2112
+ model?: string | undefined;
2113
+ name?: string | undefined;
2114
+ } | undefined;
2115
+ last_updated_on?: string | undefined;
2116
+ outstanding_amount?: number | undefined;
2117
+ }>;
2118
+ createInvoice(invoice: {
2119
+ currency: string;
2120
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
2121
+ status: "draft" | "posted" | "cancelled" | "paid";
2122
+ invoice_date: string;
2123
+ tax_amount: number;
2124
+ untaxed_amount: number;
2125
+ total: number;
2126
+ lines: {
2127
+ description?: string | undefined;
2128
+ unit_price: number;
2129
+ quantity: number;
2130
+ discount_amount: number;
2131
+ tax_amount: number;
2132
+ untaxed_amount: number;
2133
+ total: number;
2134
+ tax_rate?: number | undefined;
2135
+ account_number?: string | undefined;
2136
+ tax_id?: string | undefined;
2137
+ unit_of_measure?: string | undefined;
2138
+ product_id?: string | undefined;
2139
+ product_code?: string | undefined;
2140
+ product_name?: string | undefined;
2141
+ }[];
2142
+ partner_id?: string | undefined;
2143
+ invoice_number?: string | undefined;
2144
+ due_date?: string | undefined;
2145
+ reference?: string | undefined;
2146
+ payment_communication?: string | undefined;
2147
+ customer_memo?: string | undefined;
2148
+ journal_ref?: {
2149
+ id?: string | undefined;
2150
+ model?: string | undefined;
2151
+ name?: string | undefined;
2152
+ } | undefined;
2153
+ }): import("../types/api").RequestData<{
2154
+ id: string;
2155
+ source_ref: {
2156
+ id?: string | undefined;
2157
+ model?: string | undefined;
2158
+ };
2159
+ currency: string;
2160
+ invoice_type: "customer_invoice" | "customer_refund" | "supplier_invoice" | "supplier_refund";
2161
+ status: "draft" | "posted" | "cancelled" | "paid";
2162
+ invoice_date: string;
2163
+ tax_amount: number;
2164
+ untaxed_amount: number;
2165
+ total: number;
2166
+ lines: {
2167
+ description?: string | undefined;
2168
+ unit_price: number;
2169
+ quantity: number;
2170
+ discount_amount: number;
2171
+ tax_amount: number;
2172
+ untaxed_amount: number;
2173
+ total: number;
2174
+ tax_rate?: number | undefined;
2175
+ account_number?: string | undefined;
2176
+ tax_id?: string | undefined;
2177
+ unit_of_measure?: string | undefined;
2178
+ product_id?: string | undefined;
2179
+ product_code?: string | undefined;
2180
+ product_name?: string | undefined;
2181
+ }[];
2182
+ partner_id?: string | undefined;
2183
+ invoice_number?: string | undefined;
2184
+ due_date?: string | undefined;
2185
+ reference?: string | undefined;
2186
+ payment_communication?: string | undefined;
2187
+ customer_memo?: string | undefined;
2188
+ journal_ref?: {
2189
+ id?: string | undefined;
2190
+ model?: string | undefined;
2191
+ name?: string | undefined;
2192
+ } | undefined;
2193
+ last_updated_on?: string | undefined;
2194
+ outstanding_amount?: number | undefined;
2195
+ }>;
2196
+ getProducts(): import("../types/api").RequestData<{
2197
+ id: string;
2198
+ source_ref: {
2199
+ id?: string | undefined;
2200
+ model?: string | undefined;
2201
+ };
2202
+ name: string;
2203
+ unit_price?: number | undefined;
2204
+ tax_id?: string | undefined;
2205
+ code?: string | undefined;
2206
+ unit?: string | undefined;
2207
+ category?: string | undefined;
2208
+ currency?: string | undefined;
2209
+ description?: string | undefined;
2210
+ available_quantity: number;
2211
+ cost: number;
2212
+ }[]>;
2213
+ getProductById(productId: string): import("../types/api").RequestData<{
2214
+ id: string;
2215
+ source_ref: {
2216
+ id?: string | undefined;
2217
+ model?: string | undefined;
2218
+ };
2219
+ name: string;
2220
+ unit_price?: number | undefined;
2221
+ tax_id?: string | undefined;
2222
+ code?: string | undefined;
2223
+ unit?: string | undefined;
2224
+ category?: string | undefined;
2225
+ currency?: string | undefined;
2226
+ description?: string | undefined;
2227
+ available_quantity: number;
2228
+ cost: number;
2229
+ }>;
2230
+ createProduct(product: {
2231
+ name: string;
2232
+ unit_price?: number | undefined;
2233
+ tax_id?: string | undefined;
2234
+ code?: string | undefined;
2235
+ unit?: string | undefined;
2236
+ category?: string | undefined;
2237
+ currency?: string | undefined;
2238
+ description?: string | undefined;
2239
+ }): import("../types/api").RequestData<{
2240
+ id: string;
2241
+ source_ref: {
2242
+ id?: string | undefined;
2243
+ model?: string | undefined;
2244
+ };
2245
+ name: string;
2246
+ unit_price?: number | undefined;
2247
+ tax_id?: string | undefined;
2248
+ code?: string | undefined;
2249
+ unit?: string | undefined;
2250
+ category?: string | undefined;
2251
+ currency?: string | undefined;
2252
+ description?: string | undefined;
2253
+ available_quantity: number;
2254
+ cost: number;
2255
+ }>;
2256
+ getTaxes(): import("../types/api").RequestData<{
2257
+ id: string;
2258
+ source_ref: {
2259
+ id?: string | undefined;
2260
+ model?: string | undefined;
2261
+ };
2262
+ label: string;
2263
+ rate: number;
2264
+ type: "unknown" | "sale" | "purchase" | "both";
2265
+ code?: string | undefined;
2266
+ scope: "unknown" | "nat" | "eu" | "int";
2267
+ }[]>;
2268
+ getTaxById(taxId: string): import("../types/api").RequestData<{
2269
+ id: string;
2270
+ source_ref: {
2271
+ id?: string | undefined;
2272
+ model?: string | undefined;
2273
+ };
2274
+ label: string;
2275
+ rate: number;
2276
+ type: "unknown" | "sale" | "purchase" | "both";
2277
+ code?: string | undefined;
2278
+ scope: "unknown" | "nat" | "eu" | "int";
2279
+ }>;
2280
+ getOpportunities(): import("../types/api").RequestData<{
2281
+ id: string;
2282
+ source_ref: {
2283
+ id?: string | undefined;
2284
+ model?: string | undefined;
2285
+ };
2286
+ name: string;
2287
+ total: number;
2288
+ probability: number;
2289
+ status: "open" | "closed" | "cancelled" | "won" | "lost";
2290
+ partner_id?: string | undefined;
2291
+ comment?: string | undefined;
2292
+ currency?: string | undefined;
2293
+ description?: string | undefined;
2294
+ pipe_status?: string | undefined;
2295
+ pipe_name?: string | undefined;
2296
+ created_date?: string | undefined;
2297
+ due_date?: string | undefined;
2298
+ end_date?: string | undefined;
2299
+ is_won?: boolean | undefined;
2300
+ owner_ref?: {
2301
+ id?: string | undefined;
2302
+ model?: string | undefined;
2303
+ name?: string | undefined;
2304
+ } | undefined;
2305
+ }[]>;
2306
+ getOpportunitiesById(opportunityId: string): import("../types/api").RequestData<{
2307
+ id: string;
2308
+ source_ref: {
2309
+ id?: string | undefined;
2310
+ model?: string | undefined;
2311
+ };
2312
+ name: string;
2313
+ total: number;
2314
+ probability: number;
2315
+ status: "open" | "closed" | "cancelled" | "won" | "lost";
2316
+ partner_id?: string | undefined;
2317
+ comment?: string | undefined;
2318
+ currency?: string | undefined;
2319
+ description?: string | undefined;
2320
+ pipe_status?: string | undefined;
2321
+ pipe_name?: string | undefined;
2322
+ created_date?: string | undefined;
2323
+ due_date?: string | undefined;
2324
+ end_date?: string | undefined;
2325
+ is_won?: boolean | undefined;
2326
+ owner_ref?: {
2327
+ id?: string | undefined;
2328
+ model?: string | undefined;
2329
+ name?: string | undefined;
2330
+ } | undefined;
2331
+ }>;
2332
+ getContacts(params?: {
2333
+ contact_type?: "all" | "supplier" | "prospect" | "customer" | undefined;
2334
+ } | undefined): import("../types/api").RequestData<{
2335
+ id: string;
2336
+ source_ref: {
2337
+ id?: string | undefined;
2338
+ model?: string | undefined;
2339
+ };
2340
+ is_prospect?: boolean | undefined;
2341
+ is_customer?: boolean | undefined;
2342
+ is_supplier?: boolean | undefined;
2343
+ is_company?: boolean | undefined;
2344
+ company_name?: string | undefined;
2345
+ first_name?: string | undefined;
2346
+ last_name?: string | undefined;
2347
+ email?: string | undefined;
2348
+ phone?: string | undefined;
2349
+ mobile?: string | undefined;
2350
+ company_id?: string | undefined;
2351
+ vat?: string | undefined;
2352
+ company_number?: string | undefined;
2353
+ currency?: string | undefined;
2354
+ language?: string | undefined;
2355
+ comment?: string | undefined;
2356
+ customer_account_number?: string | undefined;
2357
+ supplier_account_number?: string | undefined;
2358
+ birthdate?: string | undefined;
2359
+ gender?: "H" | "F" | "N/A" | undefined;
2360
+ addresses: {
2361
+ address_type: "main" | "delivery" | "invoice" | "other";
2362
+ name?: string | undefined;
2363
+ number?: string | undefined;
2364
+ box?: string | undefined;
2365
+ phone?: string | undefined;
2366
+ mobile?: string | undefined;
2367
+ email?: string | undefined;
2368
+ street?: string | undefined;
2369
+ city?: string | undefined;
2370
+ postal_code?: string | undefined;
2371
+ country?: string | undefined;
2372
+ }[];
2373
+ external_reference?: string | undefined;
2374
+ }[]>;
2375
+ getContactById(contactId: string): import("../types/api").RequestData<{
2376
+ id: string;
2377
+ source_ref: {
2378
+ id?: string | undefined;
2379
+ model?: string | undefined;
2380
+ };
2381
+ is_prospect?: boolean | undefined;
2382
+ is_customer?: boolean | undefined;
2383
+ is_supplier?: boolean | undefined;
2384
+ is_company?: boolean | undefined;
2385
+ company_name?: string | undefined;
2386
+ first_name?: string | undefined;
2387
+ last_name?: string | undefined;
2388
+ email?: string | undefined;
2389
+ phone?: string | undefined;
2390
+ mobile?: string | undefined;
2391
+ company_id?: string | undefined;
2392
+ vat?: string | undefined;
2393
+ company_number?: string | undefined;
2394
+ currency?: string | undefined;
2395
+ language?: string | undefined;
2396
+ comment?: string | undefined;
2397
+ customer_account_number?: string | undefined;
2398
+ supplier_account_number?: string | undefined;
2399
+ birthdate?: string | undefined;
2400
+ gender?: "H" | "F" | "N/A" | undefined;
2401
+ addresses: {
2402
+ address_type: "main" | "delivery" | "invoice" | "other";
2403
+ name?: string | undefined;
2404
+ number?: string | undefined;
2405
+ box?: string | undefined;
2406
+ phone?: string | undefined;
2407
+ mobile?: string | undefined;
2408
+ email?: string | undefined;
2409
+ street?: string | undefined;
2410
+ city?: string | undefined;
2411
+ postal_code?: string | undefined;
2412
+ country?: string | undefined;
2413
+ }[];
2414
+ external_reference?: string | undefined;
2415
+ }>;
2416
+ createContact(contact: {
2417
+ is_prospect?: boolean | undefined;
2418
+ is_customer?: boolean | undefined;
2419
+ is_supplier?: boolean | undefined;
2420
+ is_company?: boolean | undefined;
2421
+ company_name?: string | undefined;
2422
+ first_name?: string | undefined;
2423
+ last_name?: string | undefined;
2424
+ email?: string | undefined;
2425
+ phone?: string | undefined;
2426
+ mobile?: string | undefined;
2427
+ company_id?: string | undefined;
2428
+ vat?: string | undefined;
2429
+ company_number?: string | undefined;
2430
+ currency?: string | undefined;
2431
+ language?: string | undefined;
2432
+ comment?: string | undefined;
2433
+ customer_account_number?: string | undefined;
2434
+ supplier_account_number?: string | undefined;
2435
+ birthdate?: string | undefined;
2436
+ gender?: "H" | "F" | "N/A" | undefined;
2437
+ addresses: {
2438
+ address_type: "main" | "delivery" | "invoice" | "other";
2439
+ name?: string | undefined;
2440
+ number?: string | undefined;
2441
+ box?: string | undefined;
2442
+ phone?: string | undefined;
2443
+ mobile?: string | undefined;
2444
+ email?: string | undefined;
2445
+ street: string;
2446
+ city: string;
2447
+ postal_code: string;
2448
+ country: string;
2449
+ }[];
2450
+ }): import("../types/api").RequestData<{
2451
+ id: string;
2452
+ source_ref: {
2453
+ id?: string | undefined;
2454
+ model?: string | undefined;
2455
+ };
2456
+ is_prospect?: boolean | undefined;
2457
+ is_customer?: boolean | undefined;
2458
+ is_supplier?: boolean | undefined;
2459
+ is_company?: boolean | undefined;
2460
+ company_name?: string | undefined;
2461
+ first_name?: string | undefined;
2462
+ last_name?: string | undefined;
2463
+ email?: string | undefined;
2464
+ phone?: string | undefined;
2465
+ mobile?: string | undefined;
2466
+ company_id?: string | undefined;
2467
+ vat?: string | undefined;
2468
+ company_number?: string | undefined;
2469
+ currency?: string | undefined;
2470
+ language?: string | undefined;
2471
+ comment?: string | undefined;
2472
+ customer_account_number?: string | undefined;
2473
+ supplier_account_number?: string | undefined;
2474
+ birthdate?: string | undefined;
2475
+ gender?: "H" | "F" | "N/A" | undefined;
2476
+ addresses: {
2477
+ address_type: "main" | "delivery" | "invoice" | "other";
2478
+ name?: string | undefined;
2479
+ number?: string | undefined;
2480
+ box?: string | undefined;
2481
+ phone?: string | undefined;
2482
+ mobile?: string | undefined;
2483
+ email?: string | undefined;
2484
+ street?: string | undefined;
2485
+ city?: string | undefined;
2486
+ postal_code?: string | undefined;
2487
+ country?: string | undefined;
2488
+ }[];
2489
+ external_reference?: string | undefined;
2490
+ }>;
2491
+ }>;
2492
+ ecommerce: import("../types/api").ApiFor<{
2493
+ getCustomers(): import("../types/api").RequestData<{
2494
+ id: string;
2495
+ source_ref: {
2496
+ id?: string | undefined;
2497
+ model?: string | undefined;
2498
+ };
2499
+ first_name?: string | undefined;
2500
+ last_name?: string | undefined;
2501
+ phone?: string | undefined;
2502
+ email?: string | undefined;
2503
+ language?: string | undefined;
2504
+ internal_notes?: string | undefined;
2505
+ currency?: string | undefined;
2506
+ addresses: {
2507
+ address_type: "main" | "delivery" | "invoice";
2508
+ company_name?: string | undefined;
2509
+ first_name?: string | undefined;
2510
+ last_name?: string | undefined;
2511
+ street?: string | undefined;
2512
+ number?: string | undefined;
2513
+ box?: string | undefined;
2514
+ city?: string | undefined;
2515
+ postal_code?: string | undefined;
2516
+ country?: string | undefined;
2517
+ phone?: string | undefined;
2518
+ email?: string | undefined;
2519
+ }[];
2520
+ created_on?: string | undefined;
2521
+ }[]>;
2522
+ getProducts(): import("../types/api").RequestData<{
2523
+ id: string;
2524
+ source_ref: {
2525
+ id?: string | undefined;
2526
+ model?: string | undefined;
2527
+ };
2528
+ name: string;
2529
+ description?: string | undefined;
2530
+ description_html?: string | undefined;
2531
+ categories: {
2532
+ id: string;
2533
+ name: string;
2534
+ }[];
2535
+ created_on?: string | undefined;
2536
+ variants: {
2537
+ id: string;
2538
+ source_ref: {
2539
+ id?: string | undefined;
2540
+ model?: string | undefined;
2541
+ };
2542
+ parent_id: string;
2543
+ name: string;
2544
+ description?: string | undefined;
2545
+ description_html?: string | undefined;
2546
+ categories: {
2547
+ id: string;
2548
+ name: string;
2549
+ }[];
2550
+ created_on?: string | undefined;
2551
+ sku?: string | undefined;
2552
+ barcode?: string | undefined;
2553
+ available_quantity: number;
2554
+ prices: {
2555
+ currency: string;
2556
+ price: number;
2557
+ }[];
2558
+ unit_of_measure?: string | undefined;
2559
+ weight: number;
2560
+ weight_unit?: string | undefined;
2561
+ status?: "unknown" | "archived" | "unpublished" | "published" | undefined;
2562
+ variant_attributes: {
2563
+ name: string;
2564
+ value: string;
2565
+ }[];
2566
+ variant_images: {
2567
+ id: string;
2568
+ main_image: boolean;
2569
+ url: string;
2570
+ }[];
2571
+ }[];
2572
+ status?: "unknown" | "archived" | "unpublished" | "published" | undefined;
2573
+ common_attributes: {
2574
+ name: string;
2575
+ values: string[];
2576
+ }[];
2577
+ variant_attributes_options: {
2578
+ name: string;
2579
+ values: string[];
2580
+ }[];
2581
+ common_images: {
2582
+ id: string;
2583
+ main_image: boolean;
2584
+ url: string;
2585
+ }[];
2586
+ }[]>;
2587
+ getCustomer(customerId: string): import("../types/api").RequestData<{
2588
+ id: string;
2589
+ source_ref: {
2590
+ id?: string | undefined;
2591
+ model?: string | undefined;
2592
+ };
2593
+ first_name?: string | undefined;
2594
+ last_name?: string | undefined;
2595
+ phone?: string | undefined;
2596
+ email?: string | undefined;
2597
+ language?: string | undefined;
2598
+ internal_notes?: string | undefined;
2599
+ currency?: string | undefined;
2600
+ addresses: {
2601
+ address_type: "main" | "delivery" | "invoice";
2602
+ company_name?: string | undefined;
2603
+ first_name?: string | undefined;
2604
+ last_name?: string | undefined;
2605
+ street?: string | undefined;
2606
+ number?: string | undefined;
2607
+ box?: string | undefined;
2608
+ city?: string | undefined;
2609
+ postal_code?: string | undefined;
2610
+ country?: string | undefined;
2611
+ phone?: string | undefined;
2612
+ email?: string | undefined;
2613
+ }[];
2614
+ created_on?: string | undefined;
2615
+ }>;
2616
+ getProduct(productId: string): import("../types/api").RequestData<{
2617
+ id: string;
2618
+ source_ref: {
2619
+ id?: string | undefined;
2620
+ model?: string | undefined;
2621
+ };
2622
+ name: string;
2623
+ description?: string | undefined;
2624
+ description_html?: string | undefined;
2625
+ categories: {
2626
+ id: string;
2627
+ name: string;
2628
+ }[];
2629
+ created_on?: string | undefined;
2630
+ variants: {
2631
+ id: string;
2632
+ source_ref: {
2633
+ id?: string | undefined;
2634
+ model?: string | undefined;
2635
+ };
2636
+ parent_id: string;
2637
+ name: string;
2638
+ description?: string | undefined;
2639
+ description_html?: string | undefined;
2640
+ categories: {
2641
+ id: string;
2642
+ name: string;
2643
+ }[];
2644
+ created_on?: string | undefined;
2645
+ sku?: string | undefined;
2646
+ barcode?: string | undefined;
2647
+ available_quantity: number;
2648
+ prices: {
2649
+ currency: string;
2650
+ price: number;
2651
+ }[];
2652
+ unit_of_measure?: string | undefined;
2653
+ weight: number;
2654
+ weight_unit?: string | undefined;
2655
+ status?: "unknown" | "archived" | "unpublished" | "published" | undefined;
2656
+ variant_attributes: {
2657
+ name: string;
2658
+ value: string;
2659
+ }[];
2660
+ variant_images: {
2661
+ id: string;
2662
+ main_image: boolean;
2663
+ url: string;
2664
+ }[];
2665
+ }[];
2666
+ status?: "unknown" | "archived" | "unpublished" | "published" | undefined;
2667
+ common_attributes: {
2668
+ name: string;
2669
+ values: string[];
2670
+ }[];
2671
+ variant_attributes_options: {
2672
+ name: string;
2673
+ values: string[];
2674
+ }[];
2675
+ common_images: {
2676
+ id: string;
2677
+ main_image: boolean;
2678
+ url: string;
2679
+ }[];
2680
+ }>;
2681
+ getProductVariantById(variantId: string): import("../types/api").RequestData<{
2682
+ id: string;
2683
+ source_ref: {
2684
+ id?: string | undefined;
2685
+ model?: string | undefined;
2686
+ };
2687
+ parent_id: string;
2688
+ name: string;
2689
+ description?: string | undefined;
2690
+ description_html?: string | undefined;
2691
+ categories: {
2692
+ id: string;
2693
+ name: string;
2694
+ }[];
2695
+ created_on?: string | undefined;
2696
+ sku?: string | undefined;
2697
+ barcode?: string | undefined;
2698
+ available_quantity: number;
2699
+ prices: {
2700
+ currency: string;
2701
+ price: number;
2702
+ }[];
2703
+ unit_of_measure?: string | undefined;
2704
+ weight: number;
2705
+ weight_unit?: string | undefined;
2706
+ status?: "unknown" | "archived" | "unpublished" | "published" | undefined;
2707
+ inventory_details: {
2708
+ location: {
2709
+ id: string;
2710
+ name: string;
2711
+ };
2712
+ available_quantity: number;
2713
+ }[];
2714
+ common_attributes: {
2715
+ name: string;
2716
+ values: string[];
2717
+ }[];
2718
+ variant_attributes: {
2719
+ name: string;
2720
+ value: string;
2721
+ }[];
2722
+ common_images: {
2723
+ id: string;
2724
+ main_image: boolean;
2725
+ url: string;
2726
+ }[];
2727
+ variant_images: {
2728
+ id: string;
2729
+ main_image: boolean;
2730
+ url: string;
2731
+ }[];
2732
+ }>;
2733
+ updateAvailableQuantity(variantId: string, inventoryDetails: {
2734
+ location_id: string;
2735
+ available_quantity: number;
2736
+ }): import("../types/api").RequestData<{
2737
+ location: {
2738
+ id: string;
2739
+ name: string;
2740
+ };
2741
+ available_quantity: number;
2742
+ }>;
2743
+ getLocations(): import("../types/api").RequestData<{
2744
+ id: string;
2745
+ name: string;
2746
+ }[]>;
2747
+ getOrders(params?: {
2748
+ date_from?: string | undefined;
2749
+ date_to?: string | undefined;
2750
+ updated_after?: string | undefined;
2751
+ include_detailed_refunds?: "true" | "false" | undefined;
2752
+ include_product_categories?: "true" | "false" | undefined;
2753
+ include_customer_details?: "true" | "false" | undefined;
2754
+ } | undefined): import("../types/api").RequestData<{
2755
+ id: string;
2756
+ source_ref: {
2757
+ id?: string | undefined;
2758
+ model?: string | undefined;
2759
+ };
2760
+ order_number?: string | undefined;
2761
+ customer?: {
2762
+ first_name?: string | undefined;
2763
+ last_name?: string | undefined;
2764
+ phone?: string | undefined;
2765
+ internal_notes?: string | undefined;
2766
+ email?: string | undefined;
2767
+ id: string;
2768
+ } | undefined;
2769
+ billing_address?: {
2770
+ address_type: "main" | "delivery" | "invoice";
2771
+ company_name?: string | undefined;
2772
+ first_name?: string | undefined;
2773
+ last_name?: string | undefined;
2774
+ street?: string | undefined;
2775
+ number?: string | undefined;
2776
+ box?: string | undefined;
2777
+ city?: string | undefined;
2778
+ postal_code?: string | undefined;
2779
+ country?: string | undefined;
2780
+ phone?: string | undefined;
2781
+ email?: string | undefined;
2782
+ } | undefined;
2783
+ shipping_address?: {
2784
+ address_type: "main" | "delivery" | "invoice";
2785
+ company_name?: string | undefined;
2786
+ first_name?: string | undefined;
2787
+ last_name?: string | undefined;
2788
+ street?: string | undefined;
2789
+ number?: string | undefined;
2790
+ box?: string | undefined;
2791
+ city?: string | undefined;
2792
+ postal_code?: string | undefined;
2793
+ country?: string | undefined;
2794
+ phone?: string | undefined;
2795
+ email?: string | undefined;
2796
+ } | undefined;
2797
+ created_on?: string | undefined;
2798
+ last_updated_on?: string | undefined;
2799
+ confirmed_on?: string | undefined;
2800
+ delivery_date?: string | undefined;
2801
+ cancelled_on?: string | undefined;
2802
+ status: "draft" | "cancelled" | "cancelled_unpaid" | "confirmed" | "shipped" | "refunded";
2803
+ discount_amount: number;
2804
+ untaxed_amount_without_fees: number;
2805
+ tax_amount_without_fees: number;
2806
+ total_without_fees: number;
2807
+ current_untaxed_amount: number;
2808
+ current_tax_amount: number;
2809
+ current_total: number;
2810
+ untaxed_amount: number;
2811
+ tax_amount: number;
2812
+ total: number;
2813
+ refunded_amount: number;
2814
+ currency: string;
2815
+ note?: string | undefined;
2816
+ lines: {
2817
+ id: string;
2818
+ source_ref: {
2819
+ id?: string | undefined;
2820
+ model?: string | undefined;
2821
+ };
2822
+ created_on?: string | undefined;
2823
+ variant?: {
2824
+ id: string;
2825
+ sku?: string | undefined;
2826
+ name: string;
2827
+ categories: {
2828
+ id: string;
2829
+ name: string;
2830
+ }[];
2831
+ } | undefined;
2832
+ quantity: number;
2833
+ current_quantity: number;
2834
+ unit_price: number;
2835
+ description: string;
2836
+ tax_id?: string | undefined;
2837
+ tax_rate: number;
2838
+ untaxed_amount: number;
2839
+ tax_amount: number;
2840
+ total: number;
2841
+ discounts: {
2842
+ name: string;
2843
+ description: string;
2844
+ amount: number;
2845
+ }[];
2846
+ gift_card: boolean;
2847
+ }[];
2848
+ other_fees: {
2849
+ id: string;
2850
+ source_ref: {
2851
+ id?: string | undefined;
2852
+ model?: string | undefined;
2853
+ };
2854
+ created_on?: string | undefined;
2855
+ type: "other" | "shipping";
2856
+ removed: boolean;
2857
+ tax_rate: number;
2858
+ tax_id?: string | undefined;
2859
+ discounts: {
2860
+ name: string;
2861
+ description: string;
2862
+ amount: number;
2863
+ }[];
2864
+ untaxed_amount: number;
2865
+ tax_amount: number;
2866
+ total: number;
2867
+ }[];
2868
+ payment_method_id?: string | undefined;
2869
+ transactions: {
2870
+ id: string;
2871
+ created_on?: string | undefined;
2872
+ payment_method_id?: string | undefined;
2873
+ payment_method_name?: string | undefined;
2874
+ amount: number;
2875
+ status: "pending" | "failed" | "success";
2876
+ }[];
2877
+ payment_methods: {
2878
+ id: string;
2879
+ name?: string | undefined;
2880
+ }[];
2881
+ detailed_refunds?: {
2882
+ id: string;
2883
+ source_ref: {
2884
+ id?: string | undefined;
2885
+ model?: string | undefined;
2886
+ };
2887
+ created_on?: string | undefined;
2888
+ total: number;
2889
+ reason?: string | undefined;
2890
+ order_lines: {
2891
+ id: string;
2892
+ variant?: {
2893
+ id: string;
2894
+ sku?: string | undefined;
2895
+ name: string;
2896
+ categories: {
2897
+ id: string;
2898
+ name: string;
2899
+ }[];
2900
+ } | undefined;
2901
+ quantity: number;
2902
+ untaxed_amount: number;
2903
+ tax_amount: number;
2904
+ total: number;
2905
+ }[];
2906
+ other: number;
2907
+ shipping_refunds: {
2908
+ id: string;
2909
+ source_ref: {
2910
+ id?: string | undefined;
2911
+ model?: string | undefined;
2912
+ };
2913
+ untaxed_amount: number;
2914
+ tax_amount: number;
2915
+ total: number;
2916
+ }[];
2917
+ other_fees: {
2918
+ id: string;
2919
+ source_ref: {
2920
+ id?: string | undefined;
2921
+ model?: string | undefined;
2922
+ };
2923
+ type: "other" | "shipping";
2924
+ untaxed_amount: number;
2925
+ tax_amount: number;
2926
+ total: number;
2927
+ }[];
2928
+ transactions: {
2929
+ id: string;
2930
+ created_on?: string | undefined;
2931
+ payment_method_id?: string | undefined;
2932
+ payment_method_name?: string | undefined;
2933
+ amount: number;
2934
+ status: "pending" | "failed" | "success";
2935
+ }[];
2936
+ }[] | undefined;
2937
+ returns: {
2938
+ id: string;
2939
+ source_ref: {
2940
+ id?: string | undefined;
2941
+ model?: string | undefined;
2942
+ };
2943
+ created_on?: string | undefined;
2944
+ order_lines: {
2945
+ id: string;
2946
+ variant?: {
2947
+ id: string;
2948
+ sku?: string | undefined;
2949
+ name: string;
2950
+ categories: {
2951
+ id: string;
2952
+ name: string;
2953
+ }[];
2954
+ } | undefined;
2955
+ quantity: number;
2956
+ untaxed_amount: number;
2957
+ tax_amount: number;
2958
+ total: number;
2959
+ }[];
2960
+ new_lines: {
2961
+ id: string;
2962
+ variant?: {
2963
+ id: string;
2964
+ sku?: string | undefined;
2965
+ name: string;
2966
+ categories: {
2967
+ id: string;
2968
+ name: string;
2969
+ }[];
2970
+ } | undefined;
2971
+ quantity: number;
2972
+ untaxed_amount: number;
2973
+ tax_amount: number;
2974
+ total: number;
2975
+ }[];
2976
+ linked_fees: {
2977
+ id: string;
2978
+ source_ref: {
2979
+ id?: string | undefined;
2980
+ model?: string | undefined;
2981
+ };
2982
+ type: "other" | "shipping";
2983
+ untaxed_amount: number;
2984
+ tax_amount: number;
2985
+ total: number;
2986
+ }[];
2987
+ }[];
2988
+ }[]>;
2989
+ createOrder(order: {
2990
+ customer: {
2991
+ first_name?: string | undefined;
2992
+ last_name?: string | undefined;
2993
+ phone?: string | undefined;
2994
+ internal_notes?: string | undefined;
2995
+ email: string;
2996
+ };
2997
+ billing_address: {
2998
+ first_name: string;
2999
+ last_name: string;
3000
+ street: string;
3001
+ number: string;
3002
+ box?: string | undefined;
3003
+ city: string;
3004
+ postal_code?: string | undefined;
3005
+ country: string;
3006
+ phone?: string | undefined;
3007
+ email?: string | undefined;
3008
+ };
3009
+ shipping_address: {
3010
+ first_name: string;
3011
+ last_name: string;
3012
+ street: string;
3013
+ number: string;
3014
+ box?: string | undefined;
3015
+ city: string;
3016
+ postal_code?: string | undefined;
3017
+ country: string;
3018
+ phone?: string | undefined;
3019
+ email?: string | undefined;
3020
+ };
3021
+ currency: string;
3022
+ note?: string | undefined;
3023
+ lines: {
3024
+ variant_id: string;
3025
+ quantity: number;
3026
+ tax_rate: number;
3027
+ unit_price: number;
3028
+ }[];
3029
+ payment_method?: string | undefined;
3030
+ }): import("../types/api").RequestData<{
3031
+ id: string;
3032
+ source_ref: {
3033
+ id?: string | undefined;
3034
+ model?: string | undefined;
3035
+ };
3036
+ order_number?: string | undefined;
3037
+ customer?: {
3038
+ first_name?: string | undefined;
3039
+ last_name?: string | undefined;
3040
+ phone?: string | undefined;
3041
+ internal_notes?: string | undefined;
3042
+ email?: string | undefined;
3043
+ id: string;
3044
+ } | undefined;
3045
+ billing_address?: {
3046
+ address_type: "main" | "delivery" | "invoice";
3047
+ company_name?: string | undefined;
3048
+ first_name?: string | undefined;
3049
+ last_name?: string | undefined;
3050
+ street?: string | undefined;
3051
+ number?: string | undefined;
3052
+ box?: string | undefined;
3053
+ city?: string | undefined;
3054
+ postal_code?: string | undefined;
3055
+ country?: string | undefined;
3056
+ phone?: string | undefined;
3057
+ email?: string | undefined;
3058
+ } | undefined;
3059
+ shipping_address?: {
3060
+ address_type: "main" | "delivery" | "invoice";
3061
+ company_name?: string | undefined;
3062
+ first_name?: string | undefined;
3063
+ last_name?: string | undefined;
3064
+ street?: string | undefined;
3065
+ number?: string | undefined;
3066
+ box?: string | undefined;
3067
+ city?: string | undefined;
3068
+ postal_code?: string | undefined;
3069
+ country?: string | undefined;
3070
+ phone?: string | undefined;
3071
+ email?: string | undefined;
3072
+ } | undefined;
3073
+ created_on?: string | undefined;
3074
+ last_updated_on?: string | undefined;
3075
+ confirmed_on?: string | undefined;
3076
+ delivery_date?: string | undefined;
3077
+ cancelled_on?: string | undefined;
3078
+ status: "draft" | "cancelled" | "cancelled_unpaid" | "confirmed" | "shipped" | "refunded";
3079
+ discount_amount: number;
3080
+ untaxed_amount_without_fees: number;
3081
+ tax_amount_without_fees: number;
3082
+ total_without_fees: number;
3083
+ current_untaxed_amount: number;
3084
+ current_tax_amount: number;
3085
+ current_total: number;
3086
+ untaxed_amount: number;
3087
+ tax_amount: number;
3088
+ total: number;
3089
+ refunded_amount: number;
3090
+ currency: string;
3091
+ note?: string | undefined;
3092
+ lines: {
3093
+ id: string;
3094
+ source_ref: {
3095
+ id?: string | undefined;
3096
+ model?: string | undefined;
3097
+ };
3098
+ created_on?: string | undefined;
3099
+ variant?: {
3100
+ id: string;
3101
+ sku?: string | undefined;
3102
+ name: string;
3103
+ categories: {
3104
+ id: string;
3105
+ name: string;
3106
+ }[];
3107
+ } | undefined;
3108
+ quantity: number;
3109
+ current_quantity: number;
3110
+ unit_price: number;
3111
+ description: string;
3112
+ tax_id?: string | undefined;
3113
+ tax_rate: number;
3114
+ untaxed_amount: number;
3115
+ tax_amount: number;
3116
+ total: number;
3117
+ discounts: {
3118
+ name: string;
3119
+ description: string;
3120
+ amount: number;
3121
+ }[];
3122
+ gift_card: boolean;
3123
+ }[];
3124
+ other_fees: {
3125
+ id: string;
3126
+ source_ref: {
3127
+ id?: string | undefined;
3128
+ model?: string | undefined;
3129
+ };
3130
+ created_on?: string | undefined;
3131
+ type: "other" | "shipping";
3132
+ removed: boolean;
3133
+ tax_rate: number;
3134
+ tax_id?: string | undefined;
3135
+ discounts: {
3136
+ name: string;
3137
+ description: string;
3138
+ amount: number;
3139
+ }[];
3140
+ untaxed_amount: number;
3141
+ tax_amount: number;
3142
+ total: number;
3143
+ }[];
3144
+ payment_method_id?: string | undefined;
3145
+ transactions: {
3146
+ id: string;
3147
+ created_on?: string | undefined;
3148
+ payment_method_id?: string | undefined;
3149
+ payment_method_name?: string | undefined;
3150
+ amount: number;
3151
+ status: "pending" | "failed" | "success";
3152
+ }[];
3153
+ payment_methods: {
3154
+ id: string;
3155
+ name?: string | undefined;
3156
+ }[];
3157
+ detailed_refunds?: {
3158
+ id: string;
3159
+ source_ref: {
3160
+ id?: string | undefined;
3161
+ model?: string | undefined;
3162
+ };
3163
+ created_on?: string | undefined;
3164
+ total: number;
3165
+ reason?: string | undefined;
3166
+ order_lines: {
3167
+ id: string;
3168
+ variant?: {
3169
+ id: string;
3170
+ sku?: string | undefined;
3171
+ name: string;
3172
+ categories: {
3173
+ id: string;
3174
+ name: string;
3175
+ }[];
3176
+ } | undefined;
3177
+ quantity: number;
3178
+ untaxed_amount: number;
3179
+ tax_amount: number;
3180
+ total: number;
3181
+ }[];
3182
+ other: number;
3183
+ shipping_refunds: {
3184
+ id: string;
3185
+ source_ref: {
3186
+ id?: string | undefined;
3187
+ model?: string | undefined;
3188
+ };
3189
+ untaxed_amount: number;
3190
+ tax_amount: number;
3191
+ total: number;
3192
+ }[];
3193
+ other_fees: {
3194
+ id: string;
3195
+ source_ref: {
3196
+ id?: string | undefined;
3197
+ model?: string | undefined;
3198
+ };
3199
+ type: "other" | "shipping";
3200
+ untaxed_amount: number;
3201
+ tax_amount: number;
3202
+ total: number;
3203
+ }[];
3204
+ transactions: {
3205
+ id: string;
3206
+ created_on?: string | undefined;
3207
+ payment_method_id?: string | undefined;
3208
+ payment_method_name?: string | undefined;
3209
+ amount: number;
3210
+ status: "pending" | "failed" | "success";
3211
+ }[];
3212
+ }[] | undefined;
3213
+ returns: {
3214
+ id: string;
3215
+ source_ref: {
3216
+ id?: string | undefined;
3217
+ model?: string | undefined;
3218
+ };
3219
+ created_on?: string | undefined;
3220
+ order_lines: {
3221
+ id: string;
3222
+ variant?: {
3223
+ id: string;
3224
+ sku?: string | undefined;
3225
+ name: string;
3226
+ categories: {
3227
+ id: string;
3228
+ name: string;
3229
+ }[];
3230
+ } | undefined;
3231
+ quantity: number;
3232
+ untaxed_amount: number;
3233
+ tax_amount: number;
3234
+ total: number;
3235
+ }[];
3236
+ new_lines: {
3237
+ id: string;
3238
+ variant?: {
3239
+ id: string;
3240
+ sku?: string | undefined;
3241
+ name: string;
3242
+ categories: {
3243
+ id: string;
3244
+ name: string;
3245
+ }[];
3246
+ } | undefined;
3247
+ quantity: number;
3248
+ untaxed_amount: number;
3249
+ tax_amount: number;
3250
+ total: number;
3251
+ }[];
3252
+ linked_fees: {
3253
+ id: string;
3254
+ source_ref: {
3255
+ id?: string | undefined;
3256
+ model?: string | undefined;
3257
+ };
3258
+ type: "other" | "shipping";
3259
+ untaxed_amount: number;
3260
+ tax_amount: number;
3261
+ total: number;
3262
+ }[];
3263
+ }[];
3264
+ }>;
3265
+ getOrder(orderId: string): import("../types/api").RequestData<{
3266
+ id: string;
3267
+ source_ref: {
3268
+ id?: string | undefined;
3269
+ model?: string | undefined;
3270
+ };
3271
+ order_number?: string | undefined;
3272
+ customer?: {
3273
+ first_name?: string | undefined;
3274
+ last_name?: string | undefined;
3275
+ phone?: string | undefined;
3276
+ internal_notes?: string | undefined;
3277
+ email?: string | undefined;
3278
+ id: string;
3279
+ } | undefined;
3280
+ billing_address?: {
3281
+ address_type: "main" | "delivery" | "invoice";
3282
+ company_name?: string | undefined;
3283
+ first_name?: string | undefined;
3284
+ last_name?: string | undefined;
3285
+ street?: string | undefined;
3286
+ number?: string | undefined;
3287
+ box?: string | undefined;
3288
+ city?: string | undefined;
3289
+ postal_code?: string | undefined;
3290
+ country?: string | undefined;
3291
+ phone?: string | undefined;
3292
+ email?: string | undefined;
3293
+ } | undefined;
3294
+ shipping_address?: {
3295
+ address_type: "main" | "delivery" | "invoice";
3296
+ company_name?: string | undefined;
3297
+ first_name?: string | undefined;
3298
+ last_name?: string | undefined;
3299
+ street?: string | undefined;
3300
+ number?: string | undefined;
3301
+ box?: string | undefined;
3302
+ city?: string | undefined;
3303
+ postal_code?: string | undefined;
3304
+ country?: string | undefined;
3305
+ phone?: string | undefined;
3306
+ email?: string | undefined;
3307
+ } | undefined;
3308
+ created_on?: string | undefined;
3309
+ last_updated_on?: string | undefined;
3310
+ confirmed_on?: string | undefined;
3311
+ delivery_date?: string | undefined;
3312
+ cancelled_on?: string | undefined;
3313
+ status: "draft" | "cancelled" | "cancelled_unpaid" | "confirmed" | "shipped" | "refunded";
3314
+ discount_amount: number;
3315
+ untaxed_amount_without_fees: number;
3316
+ tax_amount_without_fees: number;
3317
+ total_without_fees: number;
3318
+ current_untaxed_amount: number;
3319
+ current_tax_amount: number;
3320
+ current_total: number;
3321
+ untaxed_amount: number;
3322
+ tax_amount: number;
3323
+ total: number;
3324
+ refunded_amount: number;
3325
+ currency: string;
3326
+ note?: string | undefined;
3327
+ lines: {
3328
+ id: string;
3329
+ source_ref: {
3330
+ id?: string | undefined;
3331
+ model?: string | undefined;
3332
+ };
3333
+ created_on?: string | undefined;
3334
+ variant?: {
3335
+ id: string;
3336
+ sku?: string | undefined;
3337
+ name: string;
3338
+ categories: {
3339
+ id: string;
3340
+ name: string;
3341
+ }[];
3342
+ } | undefined;
3343
+ quantity: number;
3344
+ current_quantity: number;
3345
+ unit_price: number;
3346
+ description: string;
3347
+ tax_id?: string | undefined;
3348
+ tax_rate: number;
3349
+ untaxed_amount: number;
3350
+ tax_amount: number;
3351
+ total: number;
3352
+ discounts: {
3353
+ name: string;
3354
+ description: string;
3355
+ amount: number;
3356
+ }[];
3357
+ gift_card: boolean;
3358
+ }[];
3359
+ other_fees: {
3360
+ id: string;
3361
+ source_ref: {
3362
+ id?: string | undefined;
3363
+ model?: string | undefined;
3364
+ };
3365
+ created_on?: string | undefined;
3366
+ type: "other" | "shipping";
3367
+ removed: boolean;
3368
+ tax_rate: number;
3369
+ tax_id?: string | undefined;
3370
+ discounts: {
3371
+ name: string;
3372
+ description: string;
3373
+ amount: number;
3374
+ }[];
3375
+ untaxed_amount: number;
3376
+ tax_amount: number;
3377
+ total: number;
3378
+ }[];
3379
+ payment_method_id?: string | undefined;
3380
+ transactions: {
3381
+ id: string;
3382
+ created_on?: string | undefined;
3383
+ payment_method_id?: string | undefined;
3384
+ payment_method_name?: string | undefined;
3385
+ amount: number;
3386
+ status: "pending" | "failed" | "success";
3387
+ }[];
3388
+ payment_methods: {
3389
+ id: string;
3390
+ name?: string | undefined;
3391
+ }[];
3392
+ detailed_refunds?: {
3393
+ id: string;
3394
+ source_ref: {
3395
+ id?: string | undefined;
3396
+ model?: string | undefined;
3397
+ };
3398
+ created_on?: string | undefined;
3399
+ total: number;
3400
+ reason?: string | undefined;
3401
+ order_lines: {
3402
+ id: string;
3403
+ variant?: {
3404
+ id: string;
3405
+ sku?: string | undefined;
3406
+ name: string;
3407
+ categories: {
3408
+ id: string;
3409
+ name: string;
3410
+ }[];
3411
+ } | undefined;
3412
+ quantity: number;
3413
+ untaxed_amount: number;
3414
+ tax_amount: number;
3415
+ total: number;
3416
+ }[];
3417
+ other: number;
3418
+ shipping_refunds: {
3419
+ id: string;
3420
+ source_ref: {
3421
+ id?: string | undefined;
3422
+ model?: string | undefined;
3423
+ };
3424
+ untaxed_amount: number;
3425
+ tax_amount: number;
3426
+ total: number;
3427
+ }[];
3428
+ other_fees: {
3429
+ id: string;
3430
+ source_ref: {
3431
+ id?: string | undefined;
3432
+ model?: string | undefined;
3433
+ };
3434
+ type: "other" | "shipping";
3435
+ untaxed_amount: number;
3436
+ tax_amount: number;
3437
+ total: number;
3438
+ }[];
3439
+ transactions: {
3440
+ id: string;
3441
+ created_on?: string | undefined;
3442
+ payment_method_id?: string | undefined;
3443
+ payment_method_name?: string | undefined;
3444
+ amount: number;
3445
+ status: "pending" | "failed" | "success";
3446
+ }[];
3447
+ }[] | undefined;
3448
+ returns: {
3449
+ id: string;
3450
+ source_ref: {
3451
+ id?: string | undefined;
3452
+ model?: string | undefined;
3453
+ };
3454
+ created_on?: string | undefined;
3455
+ order_lines: {
3456
+ id: string;
3457
+ variant?: {
3458
+ id: string;
3459
+ sku?: string | undefined;
3460
+ name: string;
3461
+ categories: {
3462
+ id: string;
3463
+ name: string;
3464
+ }[];
3465
+ } | undefined;
3466
+ quantity: number;
3467
+ untaxed_amount: number;
3468
+ tax_amount: number;
3469
+ total: number;
3470
+ }[];
3471
+ new_lines: {
3472
+ id: string;
3473
+ variant?: {
3474
+ id: string;
3475
+ sku?: string | undefined;
3476
+ name: string;
3477
+ categories: {
3478
+ id: string;
3479
+ name: string;
3480
+ }[];
3481
+ } | undefined;
3482
+ quantity: number;
3483
+ untaxed_amount: number;
3484
+ tax_amount: number;
3485
+ total: number;
3486
+ }[];
3487
+ linked_fees: {
3488
+ id: string;
3489
+ source_ref: {
3490
+ id?: string | undefined;
3491
+ model?: string | undefined;
3492
+ };
3493
+ type: "other" | "shipping";
3494
+ untaxed_amount: number;
3495
+ tax_amount: number;
3496
+ total: number;
3497
+ }[];
3498
+ }[];
3499
+ }>;
3500
+ getPaymentMethods(params?: {} | undefined): import("../types/api").RequestData<{
3501
+ id: string;
3502
+ source_ref: {
3503
+ id?: string | undefined;
3504
+ model?: string | undefined;
3505
+ };
3506
+ name: string;
3507
+ active: boolean;
3508
+ }[]>;
3509
+ getProductCategories(params?: {
3510
+ only_parents?: "true" | "false" | undefined;
3511
+ } | undefined): import("../types/api").RequestData<{
3512
+ id: string;
3513
+ source_ref: {
3514
+ id?: string | undefined;
3515
+ model?: string | undefined;
3516
+ };
3517
+ name: string;
3518
+ parent_id?: string | undefined;
3519
+ }[]>;
3520
+ getTaxes(params?: {} | undefined): import("../types/api").RequestData<{
3521
+ id: string;
3522
+ source_ref: {
3523
+ id?: string | undefined;
3524
+ model?: string | undefined;
3525
+ };
3526
+ label: string;
3527
+ rate: number;
3528
+ country?: string | undefined;
3529
+ }[]>;
3530
+ getCountries(params?: {} | undefined): import("../types/api").RequestData<{
3531
+ code: string;
3532
+ name: string;
3533
+ }[]>;
3534
+ }>;
3535
+ custom: import("../types/api").ApiFor<{
3536
+ get(name: string, resource: string, params?: any): import("../types/api").RequestData<any>;
3537
+ post(name: string, resource: string, body: any, params?: any): import("../types/api").RequestData<any>;
3538
+ patch(name: string, resource: string, body: any, params?: any): import("../types/api").RequestData<any>;
3539
+ delete(name: string, resource: string, params?: any): import("../types/api").RequestData<any>;
3540
+ }>;
3541
+ getDataByDataStoreId: (dataStoreId: string, params?: object) => Promise<{
3542
+ data: Record<string, never>;
3543
+ id: string;
3544
+ created_on: string;
3545
+ }[]>;
3546
+ addDataByDataStoreId: (dataStoreId: string, data: components['schemas']['DataItem'][]) => Promise<{
3547
+ data: Record<string, never>;
3548
+ id: string;
3549
+ created_on: string;
3550
+ }[]>;
3551
+ getSyncData: (syncId: string) => Promise<{
3552
+ syncid: string;
3553
+ sync_name: string;
3554
+ status: "active" | "inactive";
3555
+ status_details?: string | undefined;
3556
+ link_createdon: string;
3557
+ link_mappings?: {
3558
+ name: string;
3559
+ description?: string | undefined;
3560
+ display_order: number;
3561
+ challenge_question?: string | undefined;
3562
+ values: {
3563
+ source_id: string;
3564
+ target_id: string;
3565
+ }[];
3566
+ sub_mapping_name: string;
3567
+ sub_mapping_description?: string | undefined;
3568
+ }[] | undefined;
3569
+ link_metadata?: Record<string, never> | undefined;
3570
+ enabled_flows?: {
3571
+ name: string;
3572
+ description?: string | undefined;
3573
+ id: string;
3574
+ config?: {
3575
+ definitionFields?: Record<string, never>[] | undefined;
3576
+ doorkeyFields?: Record<string, never>[] | undefined;
3577
+ customFields?: Record<string, never>[] | undefined;
3578
+ datastores: {
3579
+ id?: string | undefined;
3580
+ name: string;
3581
+ status: "active" | "inactive";
3582
+ definition: {
3583
+ columns: {
3584
+ name: string;
3585
+ title: string;
3586
+ type: string;
3587
+ optional: boolean;
3588
+ }[];
3589
+ search_column?: string | undefined;
3590
+ };
3591
+ }[];
3592
+ } | undefined;
3593
+ values: Record<string, never>;
3594
+ enabled_on?: string | undefined;
3595
+ trigger: {
3596
+ id: string;
3597
+ type: "event" | "timer";
3598
+ cronschedule?: string | undefined;
3599
+ };
3600
+ }[] | undefined;
3601
+ }>;
3602
+ getDataByDataStoreName: (dataStoreName: string, params?: object) => Promise<{
3603
+ data: Record<string, never>;
3604
+ id: string;
3605
+ created_on: string;
3606
+ }[]>;
3607
+ addDataByDataStoreName: (dataStoreName: string, data: components['schemas']['DataItem'][]) => Promise<{
3608
+ data: Record<string, never>;
3609
+ id: string;
3610
+ created_on: string;
3611
+ }[] | undefined>;
3612
+ updateDataStoreData: (dataStoreId: string, dataStoreDataId: string, data: components['schemas']['DataItem']) => Promise<{
3613
+ data: Record<string, never>;
3614
+ id: string;
3615
+ created_on: string;
3616
+ }[]>;
3617
+ deleteDataStoreData: (dataStoreId: string, dataStoreDataId: string) => Promise<SimpleResponseModel>;
3618
+ logData: (logs: ConsumerLog[]) => Promise<SimpleResponseModel>;
3619
+ setConnectionId: (connectionId: string) => Promise<void>;
3620
+ setIntegrationId: (integrationId: string) => Promise<void>;
3621
+ };
3622
+ export { Consumer };