@chift/chift-nodejs 1.0.18 → 1.0.20

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