@dangl/avacloud-client-node 1.60.3-avacloud-preview → 1.60.4-avacloud-preview

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 (5) hide show
  1. package/api.d.ts +97 -29
  2. package/api.js +33 -5
  3. package/api.js.map +1 -1
  4. package/api.ts +105 -29
  5. package/package.json +1 -1
package/api.ts CHANGED
@@ -2962,7 +2962,11 @@ export class GaebConversionApi {
2962
2962
  By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
2963
2963
  of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
2964
2964
  differing quantities will be kept during the import.
2965
- * @param disableItemNumberIdentifierTransformations (optional)
2965
+ * @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
2966
+ to their respective length, but spaces will not be filled with zeroes at the
2967
+ beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
2968
+ as they are in the source file, but it is not recommended to use this option since it
2969
+ may also allow incorrect or non schema compliant item numbers to be imported.
2966
2970
  */
2967
2971
  gaebConversionConvertToAva(gaebFile: FileParameter | null | undefined, supportSkippedItemNumberLevelsInPositions?: boolean | undefined, removePlainTextLongTexts?: boolean | undefined, removeHtmlLongTexts?: boolean | undefined, outputHtmlAsXml?: boolean | undefined, keepEmptyHtmlText?: boolean | undefined, allowUpperCaseItemNumbers?: boolean | undefined, allowLumpSumItemsWithDifferingQuantities?: boolean | undefined, disableItemNumberIdentifierTransformations?: boolean | undefined): Promise<SwaggerResponse<ProjectDto>> {
2968
2972
  let url_ = this.baseUrl + "/conversion/gaeb/ava?";
@@ -3074,7 +3078,11 @@ export class GaebConversionApi {
3074
3078
  By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
3075
3079
  of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
3076
3080
  differing quantities will be kept during the import.
3077
- * @param disableItemNumberIdentifierTransformations (optional)
3081
+ * @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
3082
+ to their respective length, but spaces will not be filled with zeroes at the
3083
+ beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
3084
+ as they are in the source file, but it is not recommended to use this option since it
3085
+ may also allow incorrect or non schema compliant item numbers to be imported.
3078
3086
  */
3079
3087
  gaebConversionConvertToFlatAva(gaebFile: FileParameter | null | undefined, supportSkippedItemNumberLevelsInPositions?: boolean | undefined, outputHtmlAsXml?: boolean | undefined, keepEmptyHtmlText?: boolean | undefined, allowUpperCaseItemNumbers?: boolean | undefined, allowLumpSumItemsWithDifferingQuantities?: boolean | undefined, disableItemNumberIdentifierTransformations?: boolean | undefined): Promise<SwaggerResponse<FlatAvaProject>> {
3080
3088
  let url_ = this.baseUrl + "/conversion/gaeb/flat-ava?";
@@ -3206,7 +3214,11 @@ export class GaebConversionApi {
3206
3214
  By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
3207
3215
  of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
3208
3216
  differing quantities will be kept during the import.
3209
- * @param disableItemNumberIdentifierTransformations (optional)
3217
+ * @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
3218
+ to their respective length, but spaces will not be filled with zeroes at the
3219
+ beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
3220
+ as they are in the source file, but it is not recommended to use this option since it
3221
+ may also allow incorrect or non schema compliant item numbers to be imported.
3210
3222
  */
3211
3223
  gaebConversionConvertToGaeb(gaebFile: FileParameter | null | undefined, supportSkippedItemNumberLevelsInPositions?: boolean | undefined, destinationGaebType?: DestinationGaebType | undefined, targetExchangePhaseTransform?: DestinationGaebExchangePhase | undefined, enforceStrictOfferPhaseLongTextOutput?: boolean | undefined, exportQuantityDetermination?: boolean | undefined, removeUnprintableCharactersFromTexts?: boolean | undefined, forceIncludeDescriptions?: boolean | undefined, treatNullItemNumberSchemaAsInvalid?: boolean | undefined, outputHtmlAsXml?: boolean | undefined, keepEmptyHtmlText?: boolean | undefined, allowUpperCaseItemNumbers?: boolean | undefined, allowLumpSumItemsWithDifferingQuantities?: boolean | undefined, disableItemNumberIdentifierTransformations?: boolean | undefined): Promise<SwaggerResponse<FileResponse>> {
3212
3224
  let url_ = this.baseUrl + "/conversion/gaeb/gaeb?";
@@ -3351,7 +3363,11 @@ export class GaebConversionApi {
3351
3363
  By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
3352
3364
  of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
3353
3365
  differing quantities will be kept during the import.
3354
- * @param disableItemNumberIdentifierTransformations (optional)
3366
+ * @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
3367
+ to their respective length, but spaces will not be filled with zeroes at the
3368
+ beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
3369
+ as they are in the source file, but it is not recommended to use this option since it
3370
+ may also allow incorrect or non schema compliant item numbers to be imported.
3355
3371
  */
3356
3372
  gaebConversionConvertToExcel(gaebFile: FileParameter | null | undefined, supportSkippedItemNumberLevelsInPositions?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined, outputHtmlAsXml?: boolean | undefined, keepEmptyHtmlText?: boolean | undefined, allowUpperCaseItemNumbers?: boolean | undefined, allowLumpSumItemsWithDifferingQuantities?: boolean | undefined, disableItemNumberIdentifierTransformations?: boolean | undefined): Promise<SwaggerResponse<FileResponse>> {
3357
3373
  let url_ = this.baseUrl + "/conversion/gaeb/excel?";
@@ -3486,7 +3502,11 @@ export class GaebConversionApi {
3486
3502
  By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
3487
3503
  of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
3488
3504
  differing quantities will be kept during the import.
3489
- * @param disableItemNumberIdentifierTransformations (optional)
3505
+ * @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
3506
+ to their respective length, but spaces will not be filled with zeroes at the
3507
+ beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
3508
+ as they are in the source file, but it is not recommended to use this option since it
3509
+ may also allow incorrect or non schema compliant item numbers to be imported.
3490
3510
  */
3491
3511
  gaebConversionConvertToOenorm(gaebFile: FileParameter | null | undefined, supportSkippedItemNumberLevelsInPositions?: boolean | undefined, destinationOenormType?: DestinationOenormType | undefined, tryRepairProjectStructure?: boolean | undefined, skipTryEnforceSchemaCompliantXmlOutput?: boolean | undefined, removeUnprintableCharactersFromTexts?: boolean | undefined, outputHtmlAsXml?: boolean | undefined, keepEmptyHtmlText?: boolean | undefined, allowUpperCaseItemNumbers?: boolean | undefined, allowLumpSumItemsWithDifferingQuantities?: boolean | undefined, disableItemNumberIdentifierTransformations?: boolean | undefined): Promise<SwaggerResponse<FileResponse>> {
3492
3512
  let url_ = this.baseUrl + "/conversion/gaeb/oenorm?";
@@ -6797,6 +6817,8 @@ export class ItemNumberSchemaDto implements IItemNumberSchemaDto {
6797
6817
  disableLeftPaddingTiersWithFiller!: boolean;
6798
6818
  /** If this is enabled, then item numbers will not be transformed, except padded. This makes it possible to represent item numbers as-is from e.g. a GAEB file, and also mixing padded and non-padded segments in an item number. This is not recommonded to use by default, since it will lead to inconsistent item numbers in the project. */
6799
6819
  disableItemNumberIdentifierTransformations!: boolean;
6820
+ /** This property is used in combination with DisableItemNumberIdentifierTransformations. If this is enabled, then the transformation of item numbers is only disabled for alphanumeric tiers. This means that numeric tiers will still be padded with the filler character, but alphanumeric tiers will not be transformed */
6821
+ disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers!: boolean;
6800
6822
 
6801
6823
  constructor(data?: IItemNumberSchemaDto) {
6802
6824
  if (data) {
@@ -6831,6 +6853,7 @@ export class ItemNumberSchemaDto implements IItemNumberSchemaDto {
6831
6853
  this.allowUpperCaseLettering = _data["allowUpperCaseLettering"];
6832
6854
  this.disableLeftPaddingTiersWithFiller = _data["disableLeftPaddingTiersWithFiller"];
6833
6855
  this.disableItemNumberIdentifierTransformations = _data["disableItemNumberIdentifierTransformations"];
6856
+ this.disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers = _data["disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers"];
6834
6857
  }
6835
6858
  }
6836
6859
 
@@ -6862,6 +6885,7 @@ export class ItemNumberSchemaDto implements IItemNumberSchemaDto {
6862
6885
  data["allowUpperCaseLettering"] = this.allowUpperCaseLettering;
6863
6886
  data["disableLeftPaddingTiersWithFiller"] = this.disableLeftPaddingTiersWithFiller;
6864
6887
  data["disableItemNumberIdentifierTransformations"] = this.disableItemNumberIdentifierTransformations;
6888
+ data["disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers"] = this.disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers;
6865
6889
  return data;
6866
6890
  }
6867
6891
  }
@@ -6890,6 +6914,8 @@ export interface IItemNumberSchemaDto {
6890
6914
  disableLeftPaddingTiersWithFiller: boolean;
6891
6915
  /** If this is enabled, then item numbers will not be transformed, except padded. This makes it possible to represent item numbers as-is from e.g. a GAEB file, and also mixing padded and non-padded segments in an item number. This is not recommonded to use by default, since it will lead to inconsistent item numbers in the project. */
6892
6916
  disableItemNumberIdentifierTransformations: boolean;
6917
+ /** This property is used in combination with DisableItemNumberIdentifierTransformations. If this is enabled, then the transformation of item numbers is only disabled for alphanumeric tiers. This means that numeric tiers will still be padded with the filler character, but alphanumeric tiers will not be transformed */
6918
+ disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers: boolean;
6893
6919
  }
6894
6920
 
6895
6921
  /** Represents information about a single Tier in an ItemNumber. */
@@ -11936,29 +11962,39 @@ reasons. */
11936
11962
 
11937
11963
  /** This class represents an invoice */
11938
11964
  export class Invoice implements IInvoice {
11939
- /** The number of the invoice */
11965
+ /** BT-1
11966
+ The number of the invoice */
11940
11967
  invoiceNumber?: string | undefined;
11941
- /** The date of the invoice */
11968
+ /** BT-2
11969
+ The date of the invoice */
11942
11970
  invoiceDate?: Date | undefined;
11943
- /** The type of the invoice */
11971
+ /** BT-3
11972
+ The type of the invoice */
11944
11973
  invoiceType?: InvoiceType | undefined;
11945
- /** The three letter ISO currency code */
11974
+ /** BT-5
11975
+ The three letter ISO currency code */
11946
11976
  currencyCode?: string | undefined;
11947
- /** Until when the payment is due */
11977
+ /** BT-9
11978
+ Until when the payment is due */
11948
11979
  paymentDueDate?: Date | undefined;
11949
11980
  /** An object holding reference used in this invoice */
11950
11981
  references?: References | undefined;
11951
11982
  /** A text description of payment terms, e.g. cash discounts or payment conditions */
11952
11983
  paymentTerms?: string | undefined;
11953
- /** In case of partial or final invoices, it's possible to reference the previous invoice numbers */
11984
+ /** BG-3
11985
+ In case of partial or final invoices, it's possible to reference the previous invoice numbers */
11954
11986
  previousInvoices?: PreviousInvoice[] | undefined;
11955
- /** Information about the buyer */
11987
+ /** BG-7
11988
+ Information about the buyer */
11956
11989
  buyer?: Organization | undefined;
11957
- /** Information about the seller */
11990
+ /** BG-4
11991
+ Information about the seller */
11958
11992
  seller?: Organization | undefined;
11959
- /** Information about the sellers tax representative */
11993
+ /** BG-11
11994
+ Information about the sellers tax representative */
11960
11995
  sellerTaxRepresentative?: Organization | undefined;
11961
- /** A payee is someone who receives the payment that is different from the seller */
11996
+ /** BG-10
11997
+ A payee is someone who receives the payment that is different from the seller */
11962
11998
  payee?: Payee | undefined;
11963
11999
  /** If present, this is an unstructured text that can be used to give additional information
11964
12000
  about the invoice. Field BG-1 */
@@ -12274,29 +12310,39 @@ BG-13 in XRechnung */
12274
12310
 
12275
12311
  /** This class represents an invoice */
12276
12312
  export interface IInvoice {
12277
- /** The number of the invoice */
12313
+ /** BT-1
12314
+ The number of the invoice */
12278
12315
  invoiceNumber?: string | undefined;
12279
- /** The date of the invoice */
12316
+ /** BT-2
12317
+ The date of the invoice */
12280
12318
  invoiceDate?: Date | undefined;
12281
- /** The type of the invoice */
12319
+ /** BT-3
12320
+ The type of the invoice */
12282
12321
  invoiceType?: InvoiceType | undefined;
12283
- /** The three letter ISO currency code */
12322
+ /** BT-5
12323
+ The three letter ISO currency code */
12284
12324
  currencyCode?: string | undefined;
12285
- /** Until when the payment is due */
12325
+ /** BT-9
12326
+ Until when the payment is due */
12286
12327
  paymentDueDate?: Date | undefined;
12287
12328
  /** An object holding reference used in this invoice */
12288
12329
  references?: IReferences | undefined;
12289
12330
  /** A text description of payment terms, e.g. cash discounts or payment conditions */
12290
12331
  paymentTerms?: string | undefined;
12291
- /** In case of partial or final invoices, it's possible to reference the previous invoice numbers */
12332
+ /** BG-3
12333
+ In case of partial or final invoices, it's possible to reference the previous invoice numbers */
12292
12334
  previousInvoices?: IPreviousInvoice[] | undefined;
12293
- /** Information about the buyer */
12335
+ /** BG-7
12336
+ Information about the buyer */
12294
12337
  buyer?: IOrganization | undefined;
12295
- /** Information about the seller */
12338
+ /** BG-4
12339
+ Information about the seller */
12296
12340
  seller?: IOrganization | undefined;
12297
- /** Information about the sellers tax representative */
12341
+ /** BG-11
12342
+ Information about the sellers tax representative */
12298
12343
  sellerTaxRepresentative?: IOrganization | undefined;
12299
- /** A payee is someone who receives the payment that is different from the seller */
12344
+ /** BG-10
12345
+ A payee is someone who receives the payment that is different from the seller */
12300
12346
  payee?: IPayee | undefined;
12301
12347
  /** If present, this is an unstructured text that can be used to give additional information
12302
12348
  about the invoice. Field BG-1 */
@@ -12458,9 +12504,11 @@ BT-19 in XRechnung. */
12458
12504
 
12459
12505
  /** References to previous invoices */
12460
12506
  export class PreviousInvoice implements IPreviousInvoice {
12461
- /** The date of the previous invoice */
12507
+ /** BT-26
12508
+ The date of the previous invoice */
12462
12509
  invoiceDate?: Date | undefined;
12463
- /** The number of the previous invoice */
12510
+ /** BT-25
12511
+ The number of the previous invoice */
12464
12512
  invoiceNumber!: string;
12465
12513
 
12466
12514
  constructor(data?: IPreviousInvoice) {
@@ -12496,9 +12544,11 @@ export class PreviousInvoice implements IPreviousInvoice {
12496
12544
 
12497
12545
  /** References to previous invoices */
12498
12546
  export interface IPreviousInvoice {
12499
- /** The date of the previous invoice */
12547
+ /** BT-26
12548
+ The date of the previous invoice */
12500
12549
  invoiceDate?: Date | undefined;
12501
- /** The number of the previous invoice */
12550
+ /** BT-25
12551
+ The number of the previous invoice */
12502
12552
  invoiceNumber: string;
12503
12553
  }
12504
12554
 
@@ -13617,6 +13667,16 @@ BT-91 in XRechnung. */
13617
13667
  this would be called "Verwendungszweck".
13618
13668
  BT-83 in XRechnung. */
13619
13669
  paymentId?: string | undefined;
13670
+ /** If this is a card payment, then this is the name of the cardholder.
13671
+ BT-88 in XRechnung. */
13672
+ paymentCardHolderName?: string | undefined;
13673
+ /** If this is a card payment, then this is the type of card.
13674
+ BT-87 in XRechnung. */
13675
+ paymentCardPrimaryAccountNumber?: string | undefined;
13676
+ /** If this is a card payment, then this is the type of card.
13677
+ This has no mapping yet in XRechnung, see:
13678
+ https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
13679
+ paymentCardNetworkId?: string | undefined;
13620
13680
 
13621
13681
  constructor(data?: IPaymentMeans) {
13622
13682
  if (data) {
@@ -13635,6 +13695,9 @@ BT-83 in XRechnung. */
13635
13695
  this.directDebitMandateId = _data["directDebitMandateId"];
13636
13696
  this.directDebitIban = _data["directDebitIban"];
13637
13697
  this.paymentId = _data["paymentId"];
13698
+ this.paymentCardHolderName = _data["paymentCardHolderName"];
13699
+ this.paymentCardPrimaryAccountNumber = _data["paymentCardPrimaryAccountNumber"];
13700
+ this.paymentCardNetworkId = _data["paymentCardNetworkId"];
13638
13701
  }
13639
13702
  }
13640
13703
 
@@ -13653,6 +13716,9 @@ BT-83 in XRechnung. */
13653
13716
  data["directDebitMandateId"] = this.directDebitMandateId;
13654
13717
  data["directDebitIban"] = this.directDebitIban;
13655
13718
  data["paymentId"] = this.paymentId;
13719
+ data["paymentCardHolderName"] = this.paymentCardHolderName;
13720
+ data["paymentCardPrimaryAccountNumber"] = this.paymentCardPrimaryAccountNumber;
13721
+ data["paymentCardNetworkId"] = this.paymentCardNetworkId;
13656
13722
  return data;
13657
13723
  }
13658
13724
  }
@@ -13680,6 +13746,16 @@ BT-91 in XRechnung. */
13680
13746
  this would be called "Verwendungszweck".
13681
13747
  BT-83 in XRechnung. */
13682
13748
  paymentId?: string | undefined;
13749
+ /** If this is a card payment, then this is the name of the cardholder.
13750
+ BT-88 in XRechnung. */
13751
+ paymentCardHolderName?: string | undefined;
13752
+ /** If this is a card payment, then this is the type of card.
13753
+ BT-87 in XRechnung. */
13754
+ paymentCardPrimaryAccountNumber?: string | undefined;
13755
+ /** If this is a card payment, then this is the type of card.
13756
+ This has no mapping yet in XRechnung, see:
13757
+ https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
13758
+ paymentCardNetworkId?: string | undefined;
13683
13759
  }
13684
13760
 
13685
13761
  /** Represents a document / attachment that is included with the invoice */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dangl/avacloud-client-node",
3
- "version": "1.60.3-avacloud-preview",
3
+ "version": "1.60.4-avacloud-preview",
4
4
  "description": "AVACloud client",
5
5
  "author": "Dangl IT GmbH",
6
6
  "main": "api.js",