@vario-software/types 2026.21.3 → 2026.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,14 +3,15 @@ import {
3
3
  AccountLoanValue, AccountManufacturer, AccountManufacturerDescription,
4
4
  AccountPerson, AccountRelation, AdditionalParameter, ApiCreatableReference,
5
5
  ApiObjectReference, Article, Article$Metric,
6
- ArticleAvailabilityDetermination, ArticleIdentifier, ArticleListing,
7
- ArticlePrintLabelSettings, ArticleSerialNumber, ArticleStorage,
8
- ArticleSupplier, BulkTransferRequestApi, BulkTransferResult, Contact,
9
- CountryReference, CreateNewDocumentRequest, CrmActivity, CrmActivityType,
10
- CrmChecklistItem, CrmDeal, CrmDealTopic, CrmObjectRef, CrmParticipant,
11
- CrmPriority, CrmProject, CrmReference, CrmReminder, CrmState, CrmSubType,
12
- CrmTask, CrmTaskParticipant, CrmTypedDocumentRef, CrmTypedDocumentRefList,
13
- CurrencyReference, Customer, DealNotificationEventConfig, DeliveryMethod,
6
+ ArticleAvailabilityDetermination, ArticleCustomer, ArticleIdentifier,
7
+ ArticleListing, ArticlePrintLabelSettings, ArticleSerialNumber,
8
+ ArticleStorage, ArticleSupplier, BulkTransferRequestApi,
9
+ BulkTransferResult, Contact, CountryReference, CreateNewDocumentRequest,
10
+ CrmActivity, CrmActivityType, CrmChecklistItem, CrmDeal, CrmDealTopic,
11
+ CrmObjectRef, CrmParticipant, CrmPriority, CrmProject, CrmReference,
12
+ CrmReminder, CrmState, CrmSubType, CrmTask, CrmTaskParticipant,
13
+ CrmTypedDocumentRef, CrmTypedDocumentRefList, CurrencyReference, Customer,
14
+ DangerousGoodInformation, DealNotificationEventConfig, DeliveryMethod,
14
15
  DeliveryTerm, Document, DocumentAdditionalInfo,
15
16
  DocumentAdditionalInfo$IncomingGoodsTarget,
16
17
  DocumentAdditionalInfo$IncomingGoodsTargetOfLine,
@@ -37,10 +38,11 @@ import {
37
38
  PicklistTemplate$PicklistCreationOptions,
38
39
  PicklistTemplate$PicklistProcessingOptions,
39
40
  PicklistTemplate$PicklistScript, PriceSelectionCriteria, Product,
40
- ProductDiscount, ProductGroup, ProductMainGroup, ProductPrice,
41
- RecommendedRetailPrice, RequestDocument, RequestDocumentLine,
41
+ ProductArticleRef, ProductDiscount, ProductGroup, ProductMainGroup,
42
+ ProductPrice, RecommendedRetailPrice, RequestDocument, RequestDocumentLine,
42
43
  RequestDocumentLineBooking, RequestDocumentLineCommission,
43
- RequestDocumentLineFabricationDetail, RequestDocumentPriceModifier,
44
+ RequestDocumentLineFabricationDetail,
45
+ RequestDocumentLineShippingCostDetail, RequestDocumentPriceModifier,
44
46
  RequestDocumentText, RevenueCalculation, SalesAgent, Scenario,
45
47
  ScenarioActualValue, ScenarioDimension, ScenarioDimensionValue,
46
48
  ScriptOutputRequest, ScriptingDate, ScriptingDateTime, SecureHttpClient,
@@ -371,6 +373,82 @@ export interface AccountScriptingService {
371
373
  updateRelation(accountId: number, relation: AccountRelation): AccountRelation;
372
374
  }
373
375
 
376
+ /**
377
+ * Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten
378
+ */
379
+ export interface ArticleCustomerScriptingService {
380
+
381
+ /**
382
+ * Aktiviert ein DTO
383
+ *
384
+ * @param {number} idToActivate - ID vom zu aktivierenden DTO
385
+ * @return {ArticleCustomer} Das aktivierte DTO
386
+ */
387
+ activate(idToActivate: number): ArticleCustomer;
388
+
389
+ /**
390
+ * Persistiert ein DTO
391
+ *
392
+ * @param {ArticleCustomer} toCreate - Das zu persistierende DTO
393
+ * @return {ArticleCustomer} Das persistierte DTO
394
+ */
395
+ create(toCreate: ArticleCustomer): ArticleCustomer;
396
+
397
+ /**
398
+ * Deaktiviert ein DTO
399
+ *
400
+ * @param {number} idToDeactivate - ID vom zu deaktivierenden DTO
401
+ * @return {ArticleCustomer} Das deaktivierte DTO
402
+ */
403
+ deactivate(idToDeactivate: number): ArticleCustomer;
404
+
405
+ /**
406
+ * Löscht eine Entity
407
+ *
408
+ * @param {number} id - ID der zu löschenden Entity
409
+ */
410
+ deleteById(id: number): void;
411
+
412
+ /**
413
+ * Erstellt eine neue DTO-Instanz
414
+ *
415
+ * @return {ArticleCustomer} Die neue DTO-Instanz
416
+ */
417
+ getNewDto(): ArticleCustomer;
418
+
419
+ /**
420
+ * Liest eine Liste von DTOs
421
+ *
422
+ * @param {Array<number>} ids - Die Liste der gelesenen DTOs
423
+ * @return {Array<ArticleCustomer>} Die Liste der gelesenen DTOs
424
+ */
425
+ readAllById(ids: Array<number>): Array<ArticleCustomer>;
426
+
427
+ /**
428
+ * Liest ein DTO
429
+ *
430
+ * @param {number} id - ID vom zu lesenden DTO
431
+ * @return {ArticleCustomer} Das gelesene DTO
432
+ */
433
+ readById(id: number): ArticleCustomer;
434
+
435
+ /**
436
+ * Persistiert eine DTO
437
+ *
438
+ * @param {ArticleCustomer} toStore - Das zu persistierende DTO
439
+ * @return {ArticleCustomer} Das persistierte DTO
440
+ */
441
+ store(toStore: ArticleCustomer): ArticleCustomer;
442
+
443
+ /**
444
+ * Aktualisiert ein persistiertes DTO
445
+ *
446
+ * @param {ArticleCustomer} toUpdate - Die zu aktualisierende Entity
447
+ * @return {ArticleCustomer} Das aktualisierte DTO
448
+ */
449
+ update(toUpdate: ArticleCustomer): ArticleCustomer;
450
+ }
451
+
374
452
  /**
375
453
  * Service zur Verarbeitung von Artikel-Listings im Skripten
376
454
  */
@@ -471,27 +549,27 @@ export interface ArticleScriptingService {
471
549
  *
472
550
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
473
551
  * @param {number} articleId - ID des zu druckenden Artikels
474
- * @param {number} articleSerialNumberId - ID der zu druckenden Seriennummer
475
- * @param {number} labelCount - Anzahl der zu druckenden Etiketten
476
552
  */
477
- addLabelToPrintBatch(batchIdentifier: string, articleId: number, articleSerialNumberId: number, labelCount: number): void;
553
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
478
554
 
479
555
  /**
480
556
  * Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
481
557
  *
482
558
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
483
559
  * @param {number} articleId - ID des zu druckenden Artikels
560
+ * @param {number} articleSerialNumberId - ID der zu druckenden Seriennummer
484
561
  * @param {number} labelCount - Anzahl der zu druckenden Etiketten
485
562
  */
486
- addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
563
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number, articleSerialNumberId: number, labelCount: number): void;
487
564
 
488
565
  /**
489
566
  * Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
490
567
  *
491
568
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
492
569
  * @param {number} articleId - ID des zu druckenden Artikels
570
+ * @param {number} labelCount - Anzahl der zu druckenden Etiketten
493
571
  */
494
- addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
572
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
495
573
 
496
574
  /**
497
575
  * Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
@@ -549,16 +627,16 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
549
627
  * Führt einen Etikettendrucklauf aus
550
628
  *
551
629
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
552
- * @param {string} reportGroupIdentifier - Name einer Etiketten-Report-Gruppe
553
630
  */
554
- executeLabelPrintBatch(batchIdentifier: string, reportGroupIdentifier: string): void;
631
+ executeLabelPrintBatch(batchIdentifier: string): void;
555
632
 
556
633
  /**
557
634
  * Führt einen Etikettendrucklauf aus
558
635
  *
559
636
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
637
+ * @param {string} reportGroupIdentifier - Name einer Etiketten-Report-Gruppe
560
638
  */
561
- executeLabelPrintBatch(batchIdentifier: string): void;
639
+ executeLabelPrintBatch(batchIdentifier: string, reportGroupIdentifier: string): void;
562
640
 
563
641
  /**
564
642
  * Liefert die Einkaufsrabatte zu einem Artikel
@@ -1567,35 +1645,35 @@ export interface DocumentScriptingService {
1567
1645
  * Löst einen Beleg auf
1568
1646
  *
1569
1647
  * @param {number} documentId - ID des aufzulösenden Belegs
1570
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1571
1648
  * @return {Document} Der aufgelöste Beleg
1572
1649
  */
1573
- dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1650
+ dissolve(documentId: number): Document;
1574
1651
 
1575
1652
  /**
1576
1653
  * Löst einen Beleg auf
1577
1654
  *
1578
1655
  * @param {number} documentId - ID des aufzulösenden Belegs
1656
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1579
1657
  * @return {Document} Der aufgelöste Beleg
1580
1658
  */
1581
- dissolve(documentId: number): Document;
1659
+ dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1582
1660
 
1583
1661
  /**
1584
1662
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1585
1663
  *
1586
1664
  * @param {number} documentId - ID des Belegs
1665
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1587
1666
  * @return {Document} Der Beleg in Bearbeitung
1588
1667
  */
1589
- edit(documentId: number): Document;
1668
+ edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1590
1669
 
1591
1670
  /**
1592
1671
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1593
1672
  *
1594
1673
  * @param {number} documentId - ID des Belegs
1595
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1596
1674
  * @return {Document} Der Beleg in Bearbeitung
1597
1675
  */
1598
- edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1676
+ edit(documentId: number): Document;
1599
1677
 
1600
1678
  /**
1601
1679
  * Erstellt ein AdditionalParameter-Objekt
@@ -1698,16 +1776,16 @@ export interface DocumentScriptingService {
1698
1776
  * Versendet einen Beleg per Mail
1699
1777
  *
1700
1778
  * @param {number} documentId - ID des zu versendenden Belegs
1779
+ * @param {string} reportGroupIdentifier -
1701
1780
  */
1702
- sendViaMail(documentId: number): void;
1781
+ sendViaMail(documentId: number, reportGroupIdentifier: string): void;
1703
1782
 
1704
1783
  /**
1705
1784
  * Versendet einen Beleg per Mail
1706
1785
  *
1707
1786
  * @param {number} documentId - ID des zu versendenden Belegs
1708
- * @param {string} reportGroupIdentifier -
1709
1787
  */
1710
- sendViaMail(documentId: number, reportGroupIdentifier: string): void;
1788
+ sendViaMail(documentId: number): void;
1711
1789
 
1712
1790
  /**
1713
1791
  * Überführt einen Beleg in einen anderen Status
@@ -2585,14 +2663,14 @@ export interface ScriptingServiceList {
2585
2663
  accountService: AccountScriptingService;
2586
2664
 
2587
2665
  /**
2588
- * Logging im Scripting
2666
+ * Verwaltung von Versandarten
2589
2667
  */
2590
- logger: LoggingScriptingService;
2668
+ deliveryMethodService: DeliveryMethodScriptingService;
2591
2669
 
2592
2670
  /**
2593
- * Verwaltung von Versandarten
2671
+ * Logging im Scripting
2594
2672
  */
2595
- deliveryMethodService: DeliveryMethodScriptingService;
2673
+ logger: LoggingScriptingService;
2596
2674
 
2597
2675
  /**
2598
2676
  * Service zur Verarbeitung von Deals
@@ -2610,14 +2688,14 @@ export interface ScriptingServiceList {
2610
2688
  productGroupService: ProductGroupScriptingService;
2611
2689
 
2612
2690
  /**
2613
- * Ausgabe-Support Methoden
2691
+ * Service zur Verarbeitung von Hauptwarengruppen im Skripten
2614
2692
  */
2615
- outputHelper: ScriptOutputHelperService;
2693
+ productMainGroupService: ProductMainGroupScriptingService;
2616
2694
 
2617
2695
  /**
2618
- * Service zur Verarbeitung von Hauptwarengruppen im Skripten
2696
+ * Ausgabe-Support Methoden
2619
2697
  */
2620
- productMainGroupService: ProductMainGroupScriptingService;
2698
+ outputHelper: ScriptOutputHelperService;
2621
2699
 
2622
2700
  /**
2623
2701
  * Service zur Verarbeitung von Account-Listings in Skripten
@@ -2639,6 +2717,11 @@ export interface ScriptingServiceList {
2639
2717
  */
2640
2718
  utils: ScriptingUtilities;
2641
2719
 
2720
+ /**
2721
+ * Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten
2722
+ */
2723
+ articleCustomerService: ArticleCustomerScriptingService;
2724
+
2642
2725
  /**
2643
2726
  * Service zur Verarbeitung von Variantenschemas in Skripten
2644
2727
  */
@@ -2670,14 +2753,14 @@ export interface ScriptingServiceList {
2670
2753
  articleStorageService: ArticleStorageScriptingService;
2671
2754
 
2672
2755
  /**
2673
- * Anfragen von neuen Zählerkreis-Nummern
2756
+ * Verwaltung von Zahlungsarten
2674
2757
  */
2675
- freeSequencerService: FreeSequencerScriptingService;
2758
+ paymentMethodService: PaymentMethodScriptingService;
2676
2759
 
2677
2760
  /**
2678
- * Verwaltung von Zahlungsarten
2761
+ * Anfragen von neuen Zählerkreis-Nummern
2679
2762
  */
2680
- paymentMethodService: PaymentMethodScriptingService;
2763
+ freeSequencerService: FreeSequencerScriptingService;
2681
2764
 
2682
2765
  /**
2683
2766
  * Service zur Bestandsabfrage und Lagerbuchung in Skripten
@@ -2830,24 +2913,24 @@ export interface ShelfDocumentScriptingService {
2830
2913
  deleteAttribution(attributionId: number): void;
2831
2914
 
2832
2915
  /**
2833
- * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
2916
+ * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
2834
2917
  *
2835
2918
  * @param {string} url - Download-URL
2836
- * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
2837
- * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
2838
2919
  * @param {string} documentTypeKey - Schlüssel der Dokumentenart
2839
2920
  * @return {ShelfDocument} Das neu erstellte DMS-Dokument
2840
2921
  */
2841
- downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
2922
+ downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
2842
2923
 
2843
2924
  /**
2844
- * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
2925
+ * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
2845
2926
  *
2846
2927
  * @param {string} url - Download-URL
2928
+ * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
2929
+ * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
2847
2930
  * @param {string} documentTypeKey - Schlüssel der Dokumentenart
2848
2931
  * @return {ShelfDocument} Das neu erstellte DMS-Dokument
2849
2932
  */
2850
- downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
2933
+ downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
2851
2934
 
2852
2935
  /**
2853
2936
  * Findet ein Dokumentenart über ihren Schlüssel
@@ -3749,6 +3832,13 @@ export interface dtoFactory {
3749
3832
  */
3750
3833
  createCustomer(): Customer;
3751
3834
 
3835
+ /**
3836
+ * Erstellt einen neue Instanz von DangerousGoodInformation
3837
+ *
3838
+ * @return {DangerousGoodInformation} Neue Instanz von DangerousGoodInformation
3839
+ */
3840
+ createDangerousGoodInformation(): DangerousGoodInformation;
3841
+
3752
3842
  /**
3753
3843
  * Erstellt einen neue Instanz von PicklistTemplate$DateRange
3754
3844
  *
@@ -4141,6 +4231,13 @@ export interface dtoFactory {
4141
4231
  */
4142
4232
  createPrintedTranslatedField(): DocumentAdditionalInfo$PrintedTranslatedField;
4143
4233
 
4234
+ /**
4235
+ * Erstellt einen neue Instanz von ProductArticleRef
4236
+ *
4237
+ * @return {ProductArticleRef} Neue Instanz von ProductArticleRef
4238
+ */
4239
+ createProductArticleRef(): ProductArticleRef;
4240
+
4144
4241
  /**
4145
4242
  * Erstellt einen neue Instanz von RecommendedRetailPrice
4146
4243
  *
@@ -4183,6 +4280,13 @@ export interface dtoFactory {
4183
4280
  */
4184
4281
  createRequestDocumentLineFabricationDetail(): RequestDocumentLineFabricationDetail;
4185
4282
 
4283
+ /**
4284
+ * Erstellt einen neue Instanz von RequestDocumentLineShippingCostDetail
4285
+ *
4286
+ * @return {RequestDocumentLineShippingCostDetail} Neue Instanz von RequestDocumentLineShippingCostDetail
4287
+ */
4288
+ createRequestDocumentLineShippingCostDetail(): RequestDocumentLineShippingCostDetail;
4289
+
4186
4290
  /**
4187
4291
  * Erstellt einen neue Instanz von RequestDocumentPriceModifier
4188
4292
  *