@dangl/avacloud-client-node 1.31.0 → 1.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/api.d.ts +2234 -477
- package/api.js +2383 -705
- package/api.js.map +1 -1
- package/api.ts +4126 -1616
- package/package.json +1 -1
package/api.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export declare class AslvConversionApi {
|
|
|
83
83
|
writeLongTexts?: boolean | undefined;
|
|
84
84
|
conversionCulture?: string | null | undefined;
|
|
85
85
|
includeArticleNumbers?: boolean | undefined;
|
|
86
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
86
87
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
87
88
|
/**
|
|
88
89
|
* Converts Aslv files to Excel
|
|
@@ -90,12 +91,14 @@ export declare class AslvConversionApi {
|
|
|
90
91
|
* @param writePrices (optional) Defaults to true
|
|
91
92
|
* @param writeLongTexts (optional) Defaults to true
|
|
92
93
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
93
|
-
localized Excel files
|
|
94
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
94
95
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
95
96
|
that contains the article numbers for positions. Article numbers will be read from
|
|
96
97
|
'position.commerceProperties.articleNumber'
|
|
98
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
99
|
+
be locked, so users can not accidentally modify other fields.
|
|
97
100
|
*/
|
|
98
|
-
aslvConversionConvertToExcel(aslvFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
101
|
+
aslvConversionConvertToExcel(aslvFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
99
102
|
protected processAslvConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
100
103
|
/**
|
|
101
104
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -230,6 +233,7 @@ export declare class AvaConversionApi {
|
|
|
230
233
|
writeLongTexts?: boolean | undefined;
|
|
231
234
|
conversionCulture?: string | null | undefined;
|
|
232
235
|
includeArticleNumbers?: boolean | undefined;
|
|
236
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
233
237
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
234
238
|
/**
|
|
235
239
|
* Converts Dangl.AVA projects to Excel
|
|
@@ -241,12 +245,14 @@ export declare class AvaConversionApi {
|
|
|
241
245
|
* @param writePrices (optional) Defaults to true
|
|
242
246
|
* @param writeLongTexts (optional) Defaults to true
|
|
243
247
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
244
|
-
localized Excel files
|
|
248
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
245
249
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
246
250
|
that contains the article numbers for positions. Article numbers will be read from
|
|
247
251
|
'position.commerceProperties.articleNumber'
|
|
252
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
253
|
+
be locked, so users can not accidentally modify other fields.
|
|
248
254
|
*/
|
|
249
|
-
avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
255
|
+
avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
250
256
|
protected processAvaConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
251
257
|
/**
|
|
252
258
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -371,6 +377,26 @@ export declare class AvaConversionApi {
|
|
|
371
377
|
avaConversionConvertToIdsConnect(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean | undefined, version?: IdsConnectVersion | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
372
378
|
protected processAvaConversionConvertToIdsConnect(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
373
379
|
}
|
|
380
|
+
export declare class AvaMergeApi {
|
|
381
|
+
private http;
|
|
382
|
+
private _accessToken;
|
|
383
|
+
set accessToken(token: string | null);
|
|
384
|
+
private baseUrl;
|
|
385
|
+
get basePath(): string;
|
|
386
|
+
set basePath(value: string);
|
|
387
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
388
|
+
constructor(baseUrl?: string, http?: {
|
|
389
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
390
|
+
});
|
|
391
|
+
/**
|
|
392
|
+
* This will merge two AVA projects into one. Typically this is used for merging offers into a base project, which
|
|
393
|
+
preserves the base projects structure and adds prices and text additions from the offer project.
|
|
394
|
+
This is currently in a preview phase, and the endpoint and its models are subject to change in the next versions
|
|
395
|
+
of AVACloud.
|
|
396
|
+
*/
|
|
397
|
+
avaMergeConvertToAva(mergeConfiguration: PostAvaProjectMerge): Promise<SwaggerResponse<GetProjectMergeResult>>;
|
|
398
|
+
protected processAvaMergeConvertToAva(response: Response): Promise<SwaggerResponse<GetProjectMergeResult>>;
|
|
399
|
+
}
|
|
374
400
|
export declare class DatanormConversionApi {
|
|
375
401
|
private http;
|
|
376
402
|
private _accessToken;
|
|
@@ -514,6 +540,7 @@ export declare class ExcelConversionApi {
|
|
|
514
540
|
writeLongTexts?: boolean | undefined;
|
|
515
541
|
conversionCulture?: string | null | undefined;
|
|
516
542
|
includeArticleNumbers?: boolean | undefined;
|
|
543
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
517
544
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
518
545
|
/**
|
|
519
546
|
* Converts Excel files to Excel files. Used, for example, when elements
|
|
@@ -527,12 +554,14 @@ export declare class ExcelConversionApi {
|
|
|
527
554
|
* @param writePrices (optional) Defaults to true
|
|
528
555
|
* @param writeLongTexts (optional) Defaults to true
|
|
529
556
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
530
|
-
localized Excel files
|
|
557
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
531
558
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
532
559
|
that contains the article numbers for positions. Article numbers will be read from
|
|
533
560
|
'position.commerceProperties.articleNumber'
|
|
561
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
562
|
+
be locked, so users can not accidentally modify other fields.
|
|
534
563
|
*/
|
|
535
|
-
excelConversionConvertToExcel(excelFile: FileParameter | null | undefined, readNewElements?: boolean | undefined, rebuildItemNumberSchema?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
564
|
+
excelConversionConvertToExcel(excelFile: FileParameter | null | undefined, readNewElements?: boolean | undefined, rebuildItemNumberSchema?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
536
565
|
protected processExcelConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
537
566
|
/**
|
|
538
567
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -673,6 +702,7 @@ export declare class FlatAvaConversionApi {
|
|
|
673
702
|
writeLongTexts?: boolean | undefined;
|
|
674
703
|
conversionCulture?: string | null | undefined;
|
|
675
704
|
includeArticleNumbers?: boolean | undefined;
|
|
705
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
676
706
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
677
707
|
/**
|
|
678
708
|
* Converts flat Dangl.AVA projects to Excel
|
|
@@ -684,12 +714,14 @@ export declare class FlatAvaConversionApi {
|
|
|
684
714
|
* @param writePrices (optional) Defaults to true
|
|
685
715
|
* @param writeLongTexts (optional) Defaults to true
|
|
686
716
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
687
|
-
localized Excel files
|
|
717
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
688
718
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
689
719
|
that contains the article numbers for positions. Article numbers will be read from
|
|
690
720
|
'position.commerceProperties.articleNumber'
|
|
721
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
722
|
+
be locked, so users can not accidentally modify other fields.
|
|
691
723
|
*/
|
|
692
|
-
flatAvaConversionConvertToExcel(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
724
|
+
flatAvaConversionConvertToExcel(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
693
725
|
protected processFlatAvaConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
694
726
|
/**
|
|
695
727
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -836,6 +868,7 @@ export declare class GaebConversionApi {
|
|
|
836
868
|
keepEmptyHtmlText?: boolean | undefined;
|
|
837
869
|
allowUpperCaseItemNumbers?: boolean | undefined;
|
|
838
870
|
allowLumpSumItemsWithDifferingQuantities?: boolean | undefined;
|
|
871
|
+
disableItemNumberIdentifierTransformations?: boolean | undefined;
|
|
839
872
|
}): Promise<SwaggerResponse<ProjectDto>>;
|
|
840
873
|
/**
|
|
841
874
|
* Converts GAEB files to Dangl.AVA projects
|
|
@@ -859,8 +892,13 @@ export declare class GaebConversionApi {
|
|
|
859
892
|
By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
|
|
860
893
|
of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
|
|
861
894
|
differing quantities will be kept during the import.
|
|
895
|
+
* @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
|
|
896
|
+
to their respective length, but spaces will not be filled with zeroes at the
|
|
897
|
+
beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
|
|
898
|
+
as they are in the source file, but it is not recommended to use this option since it
|
|
899
|
+
may also allow incorrect or non schema compliant item numbers to be imported.
|
|
862
900
|
*/
|
|
863
|
-
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): Promise<SwaggerResponse<ProjectDto>>;
|
|
901
|
+
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>>;
|
|
864
902
|
protected processGaebConversionConvertToAva(response: Response): Promise<SwaggerResponse<ProjectDto>>;
|
|
865
903
|
/**
|
|
866
904
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -871,6 +909,7 @@ export declare class GaebConversionApi {
|
|
|
871
909
|
keepEmptyHtmlText?: boolean | undefined;
|
|
872
910
|
allowUpperCaseItemNumbers?: boolean | undefined;
|
|
873
911
|
allowLumpSumItemsWithDifferingQuantities?: boolean | undefined;
|
|
912
|
+
disableItemNumberIdentifierTransformations?: boolean | undefined;
|
|
874
913
|
}): Promise<SwaggerResponse<FlatAvaProject>>;
|
|
875
914
|
/**
|
|
876
915
|
* Converts GAEB files to Dangl.AVA projects
|
|
@@ -892,8 +931,13 @@ export declare class GaebConversionApi {
|
|
|
892
931
|
By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
|
|
893
932
|
of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
|
|
894
933
|
differing quantities will be kept during the import.
|
|
934
|
+
* @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
|
|
935
|
+
to their respective length, but spaces will not be filled with zeroes at the
|
|
936
|
+
beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
|
|
937
|
+
as they are in the source file, but it is not recommended to use this option since it
|
|
938
|
+
may also allow incorrect or non schema compliant item numbers to be imported.
|
|
895
939
|
*/
|
|
896
|
-
gaebConversionConvertToFlatAva(gaebFile: FileParameter | null | undefined, supportSkippedItemNumberLevelsInPositions?: boolean | undefined, outputHtmlAsXml?: boolean | undefined, keepEmptyHtmlText?: boolean | undefined, allowUpperCaseItemNumbers?: boolean | undefined, allowLumpSumItemsWithDifferingQuantities?: boolean | undefined): Promise<SwaggerResponse<FlatAvaProject>>;
|
|
940
|
+
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>>;
|
|
897
941
|
protected processGaebConversionConvertToFlatAva(response: Response): Promise<SwaggerResponse<FlatAvaProject>>;
|
|
898
942
|
/**
|
|
899
943
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -911,6 +955,7 @@ export declare class GaebConversionApi {
|
|
|
911
955
|
keepEmptyHtmlText?: boolean | undefined;
|
|
912
956
|
allowUpperCaseItemNumbers?: boolean | undefined;
|
|
913
957
|
allowLumpSumItemsWithDifferingQuantities?: boolean | undefined;
|
|
958
|
+
disableItemNumberIdentifierTransformations?: boolean | undefined;
|
|
914
959
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
915
960
|
/**
|
|
916
961
|
* Converts GAEB files to GAEB files. Used for example when
|
|
@@ -960,8 +1005,13 @@ export declare class GaebConversionApi {
|
|
|
960
1005
|
By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
|
|
961
1006
|
of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
|
|
962
1007
|
differing quantities will be kept during the import.
|
|
1008
|
+
* @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
|
|
1009
|
+
to their respective length, but spaces will not be filled with zeroes at the
|
|
1010
|
+
beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
|
|
1011
|
+
as they are in the source file, but it is not recommended to use this option since it
|
|
1012
|
+
may also allow incorrect or non schema compliant item numbers to be imported.
|
|
963
1013
|
*/
|
|
964
|
-
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): Promise<SwaggerResponse<FileResponse>>;
|
|
1014
|
+
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>>;
|
|
965
1015
|
protected processGaebConversionConvertToGaeb(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
966
1016
|
/**
|
|
967
1017
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -972,10 +1022,12 @@ export declare class GaebConversionApi {
|
|
|
972
1022
|
writeLongTexts?: boolean | undefined;
|
|
973
1023
|
conversionCulture?: string | null | undefined;
|
|
974
1024
|
includeArticleNumbers?: boolean | undefined;
|
|
1025
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
975
1026
|
outputHtmlAsXml?: boolean | undefined;
|
|
976
1027
|
keepEmptyHtmlText?: boolean | undefined;
|
|
977
1028
|
allowUpperCaseItemNumbers?: boolean | undefined;
|
|
978
1029
|
allowLumpSumItemsWithDifferingQuantities?: boolean | undefined;
|
|
1030
|
+
disableItemNumberIdentifierTransformations?: boolean | undefined;
|
|
979
1031
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
980
1032
|
/**
|
|
981
1033
|
* Converts GAEB files to Excel
|
|
@@ -987,10 +1039,12 @@ export declare class GaebConversionApi {
|
|
|
987
1039
|
* @param writePrices (optional) Defaults to true
|
|
988
1040
|
* @param writeLongTexts (optional) Defaults to true
|
|
989
1041
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
990
|
-
localized Excel files
|
|
1042
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
991
1043
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
992
1044
|
that contains the article numbers for positions. Article numbers will be read from
|
|
993
1045
|
'position.commerceProperties.articleNumber'
|
|
1046
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
1047
|
+
be locked, so users can not accidentally modify other fields.
|
|
994
1048
|
* @param outputHtmlAsXml (optional) Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
|
995
1049
|
This means that e.g. void Html tags will always be output with their closing tag, e.g.
|
|
996
1050
|
it will produce '<br />' instead of '<br>'.
|
|
@@ -1004,8 +1058,13 @@ export declare class GaebConversionApi {
|
|
|
1004
1058
|
By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
|
|
1005
1059
|
of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
|
|
1006
1060
|
differing quantities will be kept during the import.
|
|
1061
|
+
* @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
|
|
1062
|
+
to their respective length, but spaces will not be filled with zeroes at the
|
|
1063
|
+
beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
|
|
1064
|
+
as they are in the source file, but it is not recommended to use this option since it
|
|
1065
|
+
may also allow incorrect or non schema compliant item numbers to be imported.
|
|
1007
1066
|
*/
|
|
1008
|
-
gaebConversionConvertToExcel(gaebFile: FileParameter | null | undefined, supportSkippedItemNumberLevelsInPositions?: boolean | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, outputHtmlAsXml?: boolean | undefined, keepEmptyHtmlText?: boolean | undefined, allowUpperCaseItemNumbers?: boolean | undefined, allowLumpSumItemsWithDifferingQuantities?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1067
|
+
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>>;
|
|
1009
1068
|
protected processGaebConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1010
1069
|
/**
|
|
1011
1070
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -1020,6 +1079,7 @@ export declare class GaebConversionApi {
|
|
|
1020
1079
|
keepEmptyHtmlText?: boolean | undefined;
|
|
1021
1080
|
allowUpperCaseItemNumbers?: boolean | undefined;
|
|
1022
1081
|
allowLumpSumItemsWithDifferingQuantities?: boolean | undefined;
|
|
1082
|
+
disableItemNumberIdentifierTransformations?: boolean | undefined;
|
|
1023
1083
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1024
1084
|
/**
|
|
1025
1085
|
* Converts GAEB files to Oenorm files
|
|
@@ -1050,8 +1110,13 @@ export declare class GaebConversionApi {
|
|
|
1050
1110
|
By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity
|
|
1051
1111
|
of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then
|
|
1052
1112
|
differing quantities will be kept during the import.
|
|
1113
|
+
* @param disableItemNumberIdentifierTransformations (optional) If this is enabled, single item number tiers will only be left padded with spaces
|
|
1114
|
+
to their respective length, but spaces will not be filled with zeroes at the
|
|
1115
|
+
beginning. Defaults to 'false'. This can be used to preserve item numbers exactly
|
|
1116
|
+
as they are in the source file, but it is not recommended to use this option since it
|
|
1117
|
+
may also allow incorrect or non schema compliant item numbers to be imported.
|
|
1053
1118
|
*/
|
|
1054
|
-
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): Promise<SwaggerResponse<FileResponse>>;
|
|
1119
|
+
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>>;
|
|
1055
1120
|
protected processGaebConversionConvertToOenorm(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1056
1121
|
}
|
|
1057
1122
|
export declare class IdsConnectConversionApi {
|
|
@@ -1104,20 +1169,33 @@ export declare class OenormConversionApi {
|
|
|
1104
1169
|
oenormConversionConvertToAvaWithRequestObject(oenormFile: FileParameter | null | undefined, options?: {
|
|
1105
1170
|
removePlainTextLongTexts?: boolean | undefined;
|
|
1106
1171
|
removeHtmlLongTexts?: boolean | undefined;
|
|
1172
|
+
useOenormFileDeclarationForItemNumberSchema?: boolean | undefined;
|
|
1107
1173
|
}): Promise<SwaggerResponse<ProjectDto>>;
|
|
1108
1174
|
/**
|
|
1109
1175
|
* Converts ÖNorm files to Dangl.AVA projects
|
|
1110
1176
|
* @param oenormFile (optional) The input file
|
|
1111
1177
|
* @param removePlainTextLongTexts (optional) If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
1112
1178
|
* @param removeHtmlLongTexts (optional) If set to true, html long texts will be removed from the output to reduce response sizes
|
|
1179
|
+
* @param useOenormFileDeclarationForItemNumberSchema (optional) If this is enabled, then the actual content structure inside the ÖNorm file is ignored. The item number
|
|
1180
|
+
schema of the target will be built based on the top level structure definition of the ÖNorm file, even if the
|
|
1181
|
+
file content itself might be different or empty
|
|
1113
1182
|
*/
|
|
1114
|
-
oenormConversionConvertToAva(oenormFile: FileParameter | null | undefined, removePlainTextLongTexts?: boolean | undefined, removeHtmlLongTexts?: boolean | undefined): Promise<SwaggerResponse<ProjectDto>>;
|
|
1183
|
+
oenormConversionConvertToAva(oenormFile: FileParameter | null | undefined, removePlainTextLongTexts?: boolean | undefined, removeHtmlLongTexts?: boolean | undefined, useOenormFileDeclarationForItemNumberSchema?: boolean | undefined): Promise<SwaggerResponse<ProjectDto>>;
|
|
1115
1184
|
protected processOenormConversionConvertToAva(response: Response): Promise<SwaggerResponse<ProjectDto>>;
|
|
1185
|
+
/**
|
|
1186
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
1187
|
+
*/
|
|
1188
|
+
oenormConversionConvertToFlatAvaWithRequestObject(oenormFile: FileParameter | null | undefined, options?: {
|
|
1189
|
+
useOenormFileDeclarationForItemNumberSchema?: boolean | undefined;
|
|
1190
|
+
}): Promise<SwaggerResponse<FlatAvaProject>>;
|
|
1116
1191
|
/**
|
|
1117
1192
|
* Converts ÖNorm files to Dangl.AVA projects
|
|
1118
1193
|
* @param oenormFile (optional) The input file
|
|
1194
|
+
* @param useOenormFileDeclarationForItemNumberSchema (optional) If this is enabled, then the actual content structure inside the ÖNorm file is ignored. The item number
|
|
1195
|
+
schema of the target will be built based on the top level structure definition of the ÖNorm file, even if the
|
|
1196
|
+
file content itself might be different or empty
|
|
1119
1197
|
*/
|
|
1120
|
-
oenormConversionConvertToFlatAva(oenormFile: FileParameter | null | undefined): Promise<SwaggerResponse<FlatAvaProject>>;
|
|
1198
|
+
oenormConversionConvertToFlatAva(oenormFile: FileParameter | null | undefined, useOenormFileDeclarationForItemNumberSchema?: boolean | undefined): Promise<SwaggerResponse<FlatAvaProject>>;
|
|
1121
1199
|
protected processOenormConversionConvertToFlatAva(response: Response): Promise<SwaggerResponse<FlatAvaProject>>;
|
|
1122
1200
|
/**
|
|
1123
1201
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -1130,6 +1208,7 @@ export declare class OenormConversionApi {
|
|
|
1130
1208
|
removeUnprintableCharactersFromTexts?: boolean | undefined;
|
|
1131
1209
|
forceIncludeDescriptions?: boolean | undefined;
|
|
1132
1210
|
treatNullItemNumberSchemaAsInvalid?: boolean | undefined;
|
|
1211
|
+
useOenormFileDeclarationForItemNumberSchema?: boolean | undefined;
|
|
1133
1212
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1134
1213
|
/**
|
|
1135
1214
|
* Converts ÖNorm files to GAEB files.
|
|
@@ -1161,8 +1240,11 @@ export declare class OenormConversionApi {
|
|
|
1161
1240
|
With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored
|
|
1162
1241
|
and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility
|
|
1163
1242
|
reasons.
|
|
1243
|
+
* @param useOenormFileDeclarationForItemNumberSchema (optional) If this is enabled, then the actual content structure inside the ÖNorm file is ignored. The item number
|
|
1244
|
+
schema of the target will be built based on the top level structure definition of the ÖNorm file, even if the
|
|
1245
|
+
file content itself might be different or empty
|
|
1164
1246
|
*/
|
|
1165
|
-
oenormConversionConvertToGaeb(oenormFile: FileParameter | null | undefined, destinationGaebType?: DestinationGaebType | undefined, targetExchangePhaseTransform?: DestinationGaebExchangePhase | undefined, enforceStrictOfferPhaseLongTextOutput?: boolean | undefined, exportQuantityDetermination?: boolean | undefined, removeUnprintableCharactersFromTexts?: boolean | undefined, forceIncludeDescriptions?: boolean | undefined, treatNullItemNumberSchemaAsInvalid?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1247
|
+
oenormConversionConvertToGaeb(oenormFile: FileParameter | null | undefined, destinationGaebType?: DestinationGaebType | undefined, targetExchangePhaseTransform?: DestinationGaebExchangePhase | undefined, enforceStrictOfferPhaseLongTextOutput?: boolean | undefined, exportQuantityDetermination?: boolean | undefined, removeUnprintableCharactersFromTexts?: boolean | undefined, forceIncludeDescriptions?: boolean | undefined, treatNullItemNumberSchemaAsInvalid?: boolean | undefined, useOenormFileDeclarationForItemNumberSchema?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1166
1248
|
protected processOenormConversionConvertToGaeb(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1167
1249
|
/**
|
|
1168
1250
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -1172,6 +1254,8 @@ export declare class OenormConversionApi {
|
|
|
1172
1254
|
writeLongTexts?: boolean | undefined;
|
|
1173
1255
|
conversionCulture?: string | null | undefined;
|
|
1174
1256
|
includeArticleNumbers?: boolean | undefined;
|
|
1257
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
1258
|
+
useOenormFileDeclarationForItemNumberSchema?: boolean | undefined;
|
|
1175
1259
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1176
1260
|
/**
|
|
1177
1261
|
* Converts ÖNorm files to Excel
|
|
@@ -1179,12 +1263,17 @@ export declare class OenormConversionApi {
|
|
|
1179
1263
|
* @param writePrices (optional) Defaults to true
|
|
1180
1264
|
* @param writeLongTexts (optional) Defaults to true
|
|
1181
1265
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
1182
|
-
localized Excel files
|
|
1266
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
1183
1267
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
1184
1268
|
that contains the article numbers for positions. Article numbers will be read from
|
|
1185
1269
|
'position.commerceProperties.articleNumber'
|
|
1270
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
1271
|
+
be locked, so users can not accidentally modify other fields.
|
|
1272
|
+
* @param useOenormFileDeclarationForItemNumberSchema (optional) If this is enabled, then the actual content structure inside the ÖNorm file is ignored. The item number
|
|
1273
|
+
schema of the target will be built based on the top level structure definition of the ÖNorm file, even if the
|
|
1274
|
+
file content itself might be different or empty
|
|
1186
1275
|
*/
|
|
1187
|
-
oenormConversionConvertToExcel(oenormFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1276
|
+
oenormConversionConvertToExcel(oenormFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined, useOenormFileDeclarationForItemNumberSchema?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1188
1277
|
protected processOenormConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1189
1278
|
/**
|
|
1190
1279
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -1194,6 +1283,7 @@ export declare class OenormConversionApi {
|
|
|
1194
1283
|
tryRepairProjectStructure?: boolean | undefined;
|
|
1195
1284
|
skipTryEnforceSchemaCompliantXmlOutput?: boolean | undefined;
|
|
1196
1285
|
removeUnprintableCharactersFromTexts?: boolean | undefined;
|
|
1286
|
+
useOenormFileDeclarationForItemNumberSchema?: boolean | undefined;
|
|
1197
1287
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1198
1288
|
/**
|
|
1199
1289
|
* Converts ÖNorm files to Oenorm files.
|
|
@@ -1207,8 +1297,11 @@ export declare class OenormConversionApi {
|
|
|
1207
1297
|
* @param removeUnprintableCharactersFromTexts (optional) If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion
|
|
1208
1298
|
might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
1209
1299
|
Defaults to true.
|
|
1300
|
+
* @param useOenormFileDeclarationForItemNumberSchema (optional) If this is enabled, then the actual content structure inside the ÖNorm file is ignored. The item number
|
|
1301
|
+
schema of the target will be built based on the top level structure definition of the ÖNorm file, even if the
|
|
1302
|
+
file content itself might be different or empty
|
|
1210
1303
|
*/
|
|
1211
|
-
oenormConversionConvertToOenorm(oenormFile: FileParameter | null | undefined, destinationOenormType?: DestinationOenormType | undefined, tryRepairProjectStructure?: boolean | undefined, skipTryEnforceSchemaCompliantXmlOutput?: boolean | undefined, removeUnprintableCharactersFromTexts?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1304
|
+
oenormConversionConvertToOenorm(oenormFile: FileParameter | null | undefined, destinationOenormType?: DestinationOenormType | undefined, tryRepairProjectStructure?: boolean | undefined, skipTryEnforceSchemaCompliantXmlOutput?: boolean | undefined, removeUnprintableCharactersFromTexts?: boolean | undefined, useOenormFileDeclarationForItemNumberSchema?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1212
1305
|
protected processOenormConversionConvertToOenorm(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1213
1306
|
}
|
|
1214
1307
|
export declare class RebConversionApi {
|
|
@@ -1296,6 +1389,7 @@ export declare class RebConversionApi {
|
|
|
1296
1389
|
writeLongTexts?: boolean | undefined;
|
|
1297
1390
|
conversionCulture?: string | null | undefined;
|
|
1298
1391
|
includeArticleNumbers?: boolean | undefined;
|
|
1392
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
1299
1393
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1300
1394
|
/**
|
|
1301
1395
|
* Converts REB files to Excel
|
|
@@ -1303,12 +1397,14 @@ export declare class RebConversionApi {
|
|
|
1303
1397
|
* @param writePrices (optional) Defaults to true
|
|
1304
1398
|
* @param writeLongTexts (optional) Defaults to true
|
|
1305
1399
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
1306
|
-
localized Excel files
|
|
1400
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
1307
1401
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
1308
1402
|
that contains the article numbers for positions. Article numbers will be read from
|
|
1309
1403
|
'position.commerceProperties.articleNumber'
|
|
1404
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
1405
|
+
be locked, so users can not accidentally modify other fields.
|
|
1310
1406
|
*/
|
|
1311
|
-
rebConversionConvertToExcel(rebFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1407
|
+
rebConversionConvertToExcel(rebFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1312
1408
|
protected processRebConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1313
1409
|
/**
|
|
1314
1410
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -1420,6 +1516,7 @@ export declare class SiaConversionApi {
|
|
|
1420
1516
|
writeLongTexts?: boolean | undefined;
|
|
1421
1517
|
conversionCulture?: string | null | undefined;
|
|
1422
1518
|
includeArticleNumbers?: boolean | undefined;
|
|
1519
|
+
lockAllCellsButPrices?: boolean | undefined;
|
|
1423
1520
|
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1424
1521
|
/**
|
|
1425
1522
|
* Converts SIA 451 files to Excel
|
|
@@ -1427,12 +1524,14 @@ export declare class SiaConversionApi {
|
|
|
1427
1524
|
* @param writePrices (optional) Defaults to true
|
|
1428
1525
|
* @param writeLongTexts (optional) Defaults to true
|
|
1429
1526
|
* @param conversionCulture (optional) The culture that should be used for the conversion process, to have
|
|
1430
|
-
localized Excel files
|
|
1527
|
+
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
|
|
1431
1528
|
* @param includeArticleNumbers (optional) If this is enabled, then a new column will be created in the overview worksheet
|
|
1432
1529
|
that contains the article numbers for positions. Article numbers will be read from
|
|
1433
1530
|
'position.commerceProperties.articleNumber'
|
|
1531
|
+
* @param lockAllCellsButPrices (optional) If this is enabled, then all cells except the unit price cells will
|
|
1532
|
+
be locked, so users can not accidentally modify other fields.
|
|
1434
1533
|
*/
|
|
1435
|
-
siaConversionConvertToExcel(siaFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1534
|
+
siaConversionConvertToExcel(siaFile: FileParameter | null | undefined, writePrices?: boolean | undefined, writeLongTexts?: boolean | undefined, conversionCulture?: string | null | undefined, includeArticleNumbers?: boolean | undefined, lockAllCellsButPrices?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1436
1535
|
protected processSiaConversionConvertToExcel(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1437
1536
|
/**
|
|
1438
1537
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
@@ -1566,16 +1665,73 @@ export declare class XRechnungConversionApi {
|
|
|
1566
1665
|
*/
|
|
1567
1666
|
xRechnungConversionConvertXRechnungToAva(xrechnungFile: FileParameter | null | undefined): Promise<SwaggerResponse<AvaProjectWrapper>>;
|
|
1568
1667
|
protected processXRechnungConversionConvertXRechnungToAva(response: Response): Promise<SwaggerResponse<AvaProjectWrapper>>;
|
|
1668
|
+
/**
|
|
1669
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
1670
|
+
*/
|
|
1671
|
+
xRechnungConversionConvertInvoiceToXRechnungWithRequestObject(invoice: Invoice, options?: {
|
|
1672
|
+
targetFormat?: DestinationXRechnungFormat | undefined;
|
|
1673
|
+
disablePriceRounding?: boolean | undefined;
|
|
1674
|
+
disableBrandingComment?: boolean | undefined;
|
|
1675
|
+
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1569
1676
|
/**
|
|
1570
1677
|
* This will convert an Invoice object to an XRechnung file
|
|
1678
|
+
* @param targetFormat (optional) The target format for the XRechnung export. Defaults to Ubl. Options are:
|
|
1679
|
+
Ubl, CrossIndustryInvoice and FacturX (ZUGFerd)
|
|
1680
|
+
* @param disablePriceRounding (optional) If this is enabled, then the price values in the XRechnung export will not be rounded.
|
|
1681
|
+
Otherwise, prices will by default be rounded to two decimal places.
|
|
1682
|
+
* @param disableBrandingComment (optional) If this is set to true, exported XRechnung files will not contain an XML comment
|
|
1683
|
+
indicating their origin. This is false by default, meaning the comment will be included.
|
|
1571
1684
|
*/
|
|
1572
|
-
xRechnungConversionConvertInvoiceToXRechnung(invoice: Invoice): Promise<SwaggerResponse<FileResponse>>;
|
|
1685
|
+
xRechnungConversionConvertInvoiceToXRechnung(invoice: Invoice, targetFormat?: DestinationXRechnungFormat | undefined, disablePriceRounding?: boolean | undefined, disableBrandingComment?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1573
1686
|
protected processXRechnungConversionConvertInvoiceToXRechnung(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1687
|
+
/**
|
|
1688
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
1689
|
+
*/
|
|
1690
|
+
xRechnungConversionConvertAvaToXRechnungWithRequestObject(avaWrapper: AvaProjectWrapper, options?: {
|
|
1691
|
+
targetFormat?: DestinationXRechnungFormat | undefined;
|
|
1692
|
+
disablePriceRounding?: boolean | undefined;
|
|
1693
|
+
disableBrandingComment?: boolean | undefined;
|
|
1694
|
+
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1574
1695
|
/**
|
|
1575
1696
|
* This will convert an AVA wrapper object to an XRechnung file
|
|
1697
|
+
* @param targetFormat (optional) The target format for the XRechnung export. Defaults to Ubl. Options are:
|
|
1698
|
+
Ubl, CrossIndustryInvoice and FacturX (ZUGFerd)
|
|
1699
|
+
* @param disablePriceRounding (optional) If this is enabled, then the price values in the XRechnung export will not be rounded.
|
|
1700
|
+
Otherwise, prices will by default be rounded to two decimal places.
|
|
1701
|
+
* @param disableBrandingComment (optional) If this is set to true, exported XRechnung files will not contain an XML comment
|
|
1702
|
+
indicating their origin. This is false by default, meaning the comment will be included.
|
|
1576
1703
|
*/
|
|
1577
|
-
xRechnungConversionConvertAvaToXRechnung(avaWrapper: AvaProjectWrapper): Promise<SwaggerResponse<FileResponse>>;
|
|
1704
|
+
xRechnungConversionConvertAvaToXRechnung(avaWrapper: AvaProjectWrapper, targetFormat?: DestinationXRechnungFormat | undefined, disablePriceRounding?: boolean | undefined, disableBrandingComment?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1578
1705
|
protected processXRechnungConversionConvertAvaToXRechnung(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1706
|
+
/**
|
|
1707
|
+
* This will convert an Invoice object to a PDF file
|
|
1708
|
+
*/
|
|
1709
|
+
xRechnungConversionConvertInvoiceToPdfInvoice(invoice: Invoice): Promise<SwaggerResponse<FileResponse>>;
|
|
1710
|
+
protected processXRechnungConversionConvertInvoiceToPdfInvoice(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1711
|
+
/**
|
|
1712
|
+
* This will convert an AVA wrapper object to a PDF file
|
|
1713
|
+
*/
|
|
1714
|
+
xRechnungConversionConvertAvaToPdfInvoice(avaWrapper: AvaProjectWrapper): Promise<SwaggerResponse<FileResponse>>;
|
|
1715
|
+
protected processXRechnungConversionConvertAvaToPdfInvoice(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1716
|
+
/**
|
|
1717
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
1718
|
+
*/
|
|
1719
|
+
xRechnungConversionMergeInvoiceIntoPdfFileWithRequestObject(pdfEmbeddModel: PostXRechnungPdfEmbedd, options?: {
|
|
1720
|
+
targetFormat?: DestinationXRechnungFormat | undefined;
|
|
1721
|
+
disablePriceRounding?: boolean | undefined;
|
|
1722
|
+
disableBrandingComment?: boolean | undefined;
|
|
1723
|
+
}): Promise<SwaggerResponse<FileResponse>>;
|
|
1724
|
+
/**
|
|
1725
|
+
* This will embedd an XRechnung file into an existing PDF file as an attachment.
|
|
1726
|
+
* @param targetFormat (optional) The target format for the XRechnung export. Defaults to Ubl. Options are:
|
|
1727
|
+
Ubl, CrossIndustryInvoice and FacturX (ZUGFerd)
|
|
1728
|
+
* @param disablePriceRounding (optional) If this is enabled, then the price values in the XRechnung export will not be rounded.
|
|
1729
|
+
Otherwise, prices will by default be rounded to two decimal places.
|
|
1730
|
+
* @param disableBrandingComment (optional) If this is set to true, exported XRechnung files will not contain an XML comment
|
|
1731
|
+
indicating their origin. This is false by default, meaning the comment will be included.
|
|
1732
|
+
*/
|
|
1733
|
+
xRechnungConversionMergeInvoiceIntoPdfFile(pdfEmbeddModel: PostXRechnungPdfEmbedd, targetFormat?: DestinationXRechnungFormat | undefined, disablePriceRounding?: boolean | undefined, disableBrandingComment?: boolean | undefined): Promise<SwaggerResponse<FileResponse>>;
|
|
1734
|
+
protected processXRechnungConversionMergeInvoiceIntoPdfFile(response: Response): Promise<SwaggerResponse<FileResponse>>;
|
|
1579
1735
|
}
|
|
1580
1736
|
export declare class DanglIdentityApi {
|
|
1581
1737
|
private http;
|
|
@@ -1628,9 +1784,9 @@ export declare class ProjectDto implements IProjectDto {
|
|
|
1628
1784
|
/** This is used to store the GAEB XML Id within this Project. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
1629
1785
|
gaebXmlId?: string | undefined;
|
|
1630
1786
|
constructor(data?: IProjectDto);
|
|
1631
|
-
init(_data?: any): void;
|
|
1787
|
+
init?(_data?: any): void;
|
|
1632
1788
|
static fromJS(data: any): ProjectDto;
|
|
1633
|
-
toJSON(data?: any): any;
|
|
1789
|
+
toJSON?(data?: any): any;
|
|
1634
1790
|
}
|
|
1635
1791
|
/** A Project contains all relevant information for a construction project. */
|
|
1636
1792
|
export interface IProjectDto {
|
|
@@ -1696,9 +1852,9 @@ export declare class ProjectInformationDto implements IProjectInformationDto {
|
|
|
1696
1852
|
/** Notification sites are addresses that are used for delivering messages in the context of construction projects. */
|
|
1697
1853
|
notificationSites?: PartyInformationDto[] | undefined;
|
|
1698
1854
|
constructor(data?: IProjectInformationDto);
|
|
1699
|
-
init(_data?: any): void;
|
|
1855
|
+
init?(_data?: any): void;
|
|
1700
1856
|
static fromJS(data: any): ProjectInformationDto;
|
|
1701
|
-
toJSON(data?: any): any;
|
|
1857
|
+
toJSON?(data?: any): any;
|
|
1702
1858
|
}
|
|
1703
1859
|
/** General information about a Project. */
|
|
1704
1860
|
export interface IProjectInformationDto {
|
|
@@ -1781,10 +1937,12 @@ export declare class PartyInformationDto implements IPartyInformationDto {
|
|
|
1781
1937
|
bankingInformation?: BankingInformationDto[] | undefined;
|
|
1782
1938
|
/** This can be used to specify a registration number for this party, e.g. a company registration number. It is usually used in GAEB XML commerce exchanges for bidders to supply their WEEE registration number, which is used to identify them as a registered WEEE company. */
|
|
1783
1939
|
registrationNumber?: string | undefined;
|
|
1940
|
+
/** This can be used to specify a tax id for this party. It is different from the VatId and the RegistrationNumber. For example, in Germany this would be the "Steuernummer". This is usually not mapped to any AVA exchanges, but it's used e.g. in the XRechnung electronic invoices. */
|
|
1941
|
+
taxId?: string | undefined;
|
|
1784
1942
|
constructor(data?: IPartyInformationDto);
|
|
1785
|
-
init(_data?: any): void;
|
|
1943
|
+
init?(_data?: any): void;
|
|
1786
1944
|
static fromJS(data: any): PartyInformationDto;
|
|
1787
|
-
toJSON(data?: any): any;
|
|
1945
|
+
toJSON?(data?: any): any;
|
|
1788
1946
|
}
|
|
1789
1947
|
/** Represents information about a party (a site or an organization). */
|
|
1790
1948
|
export interface IPartyInformationDto {
|
|
@@ -1828,6 +1986,8 @@ export interface IPartyInformationDto {
|
|
|
1828
1986
|
bankingInformation?: IBankingInformationDto[] | undefined;
|
|
1829
1987
|
/** This can be used to specify a registration number for this party, e.g. a company registration number. It is usually used in GAEB XML commerce exchanges for bidders to supply their WEEE registration number, which is used to identify them as a registered WEEE company. */
|
|
1830
1988
|
registrationNumber?: string | undefined;
|
|
1989
|
+
/** This can be used to specify a tax id for this party. It is different from the VatId and the RegistrationNumber. For example, in Germany this would be the "Steuernummer". This is usually not mapped to any AVA exchanges, but it's used e.g. in the XRechnung electronic invoices. */
|
|
1990
|
+
taxId?: string | undefined;
|
|
1831
1991
|
}
|
|
1832
1992
|
/** This is a class that represents the information about a bank connection. It is usually used within a PartyInformation. */
|
|
1833
1993
|
export declare class BankingInformationDto implements IBankingInformationDto {
|
|
@@ -1844,9 +2004,9 @@ export declare class BankingInformationDto implements IBankingInformationDto {
|
|
|
1844
2004
|
/** The routing number for the bank. Typically no longer used since the introduction of IBAN within the SEPA area. */
|
|
1845
2005
|
routingNumber?: string | undefined;
|
|
1846
2006
|
constructor(data?: IBankingInformationDto);
|
|
1847
|
-
init(_data?: any): void;
|
|
2007
|
+
init?(_data?: any): void;
|
|
1848
2008
|
static fromJS(data: any): BankingInformationDto;
|
|
1849
|
-
toJSON(data?: any): any;
|
|
2009
|
+
toJSON?(data?: any): any;
|
|
1850
2010
|
}
|
|
1851
2011
|
/** This is a class that represents the information about a bank connection. It is usually used within a PartyInformation. */
|
|
1852
2012
|
export interface IBankingInformationDto {
|
|
@@ -1885,10 +2045,14 @@ export declare class ItemNumberSchemaDto implements IItemNumberSchemaDto {
|
|
|
1885
2045
|
allowUpperCaseLettering: boolean;
|
|
1886
2046
|
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
1887
2047
|
disableLeftPaddingTiersWithFiller: boolean;
|
|
2048
|
+
/** 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. */
|
|
2049
|
+
disableItemNumberIdentifierTransformations: boolean;
|
|
2050
|
+
/** 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 */
|
|
2051
|
+
disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers: boolean;
|
|
1888
2052
|
constructor(data?: IItemNumberSchemaDto);
|
|
1889
|
-
init(_data?: any): void;
|
|
2053
|
+
init?(_data?: any): void;
|
|
1890
2054
|
static fromJS(data: any): ItemNumberSchemaDto;
|
|
1891
|
-
toJSON(data?: any): any;
|
|
2055
|
+
toJSON?(data?: any): any;
|
|
1892
2056
|
}
|
|
1893
2057
|
/** The schema for ItemNumber's in a Project. */
|
|
1894
2058
|
export interface IItemNumberSchemaDto {
|
|
@@ -1912,6 +2076,10 @@ export interface IItemNumberSchemaDto {
|
|
|
1912
2076
|
allowUpperCaseLettering: boolean;
|
|
1913
2077
|
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
1914
2078
|
disableLeftPaddingTiersWithFiller: boolean;
|
|
2079
|
+
/** 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. */
|
|
2080
|
+
disableItemNumberIdentifierTransformations: boolean;
|
|
2081
|
+
/** 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 */
|
|
2082
|
+
disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers: boolean;
|
|
1915
2083
|
}
|
|
1916
2084
|
/** Represents information about a single Tier in an ItemNumber. */
|
|
1917
2085
|
export declare class ItemNumberSchemaTierDto implements IItemNumberSchemaTierDto {
|
|
@@ -1919,6 +2087,8 @@ export declare class ItemNumberSchemaTierDto implements IItemNumberSchemaTierDto
|
|
|
1919
2087
|
length: number;
|
|
1920
2088
|
/** This ItemNumberSchemaTier's type. */
|
|
1921
2089
|
type: ItemNumberTypeDto;
|
|
2090
|
+
/** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
|
|
2091
|
+
alignment?: ItemNumberSchemaTierAlignmentDto | undefined;
|
|
1922
2092
|
/** This specifies which ItemNumberSchemaTierType this tier represents. This can be, for example, a group tier / level, a position level or a lot level. */
|
|
1923
2093
|
tierType: ItemNumberSchemaTierTypeDto;
|
|
1924
2094
|
/** Indicates if this tier represents a lot. See the documentation for more information about lots. */
|
|
@@ -1928,9 +2098,9 @@ export declare class ItemNumberSchemaTierDto implements IItemNumberSchemaTierDto
|
|
|
1928
2098
|
/** This is an optional name for the given tier */
|
|
1929
2099
|
tierName?: string | undefined;
|
|
1930
2100
|
constructor(data?: IItemNumberSchemaTierDto);
|
|
1931
|
-
init(_data?: any): void;
|
|
2101
|
+
init?(_data?: any): void;
|
|
1932
2102
|
static fromJS(data: any): ItemNumberSchemaTierDto;
|
|
1933
|
-
toJSON(data?: any): any;
|
|
2103
|
+
toJSON?(data?: any): any;
|
|
1934
2104
|
}
|
|
1935
2105
|
/** Represents information about a single Tier in an ItemNumber. */
|
|
1936
2106
|
export interface IItemNumberSchemaTierDto {
|
|
@@ -1938,6 +2108,8 @@ export interface IItemNumberSchemaTierDto {
|
|
|
1938
2108
|
length: number;
|
|
1939
2109
|
/** This ItemNumberSchemaTier's type. */
|
|
1940
2110
|
type: ItemNumberTypeDto;
|
|
2111
|
+
/** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
|
|
2112
|
+
alignment?: ItemNumberSchemaTierAlignmentDto | undefined;
|
|
1941
2113
|
/** This specifies which ItemNumberSchemaTierType this tier represents. This can be, for example, a group tier / level, a position level or a lot level. */
|
|
1942
2114
|
tierType: ItemNumberSchemaTierTypeDto;
|
|
1943
2115
|
/** Indicates if this tier represents a lot. See the documentation for more information about lots. */
|
|
@@ -1952,6 +2124,12 @@ export declare enum ItemNumberTypeDto {
|
|
|
1952
2124
|
Numeric = "Numeric",
|
|
1953
2125
|
Alphanumeric = "Alphanumeric"
|
|
1954
2126
|
}
|
|
2127
|
+
/** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
|
|
2128
|
+
export declare enum ItemNumberSchemaTierAlignmentDto {
|
|
2129
|
+
Undefined = "Undefined",
|
|
2130
|
+
Left = "Left",
|
|
2131
|
+
Right = "Right"
|
|
2132
|
+
}
|
|
1955
2133
|
/** Specifies the type an ItemNumberSchemaTier represents. For example, a tier may indicate to be used for positions or for groups. */
|
|
1956
2134
|
export declare enum ItemNumberSchemaTierTypeDto {
|
|
1957
2135
|
Undefined = "Undefined",
|
|
@@ -1980,7 +2158,8 @@ export declare enum AwardTypeDto {
|
|
|
1980
2158
|
SelectedCall = "SelectedCall",
|
|
1981
2159
|
DirectAward = "DirectAward",
|
|
1982
2160
|
InternationalNATOProcurement = "InternationalNATOProcurement",
|
|
1983
|
-
CompetitiveDialog = "CompetitiveDialog"
|
|
2161
|
+
CompetitiveDialog = "CompetitiveDialog",
|
|
2162
|
+
InnovationPartnership = "InnovationPartnership"
|
|
1984
2163
|
}
|
|
1985
2164
|
/** This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary */
|
|
1986
2165
|
export declare enum SpecialAwardKindDto {
|
|
@@ -2094,9 +2273,9 @@ export declare class ServiceSpecificationDto implements IServiceSpecificationDto
|
|
|
2094
2273
|
/** This property holds additional information that's only valid in commerce exchange phases. */
|
|
2095
2274
|
commerceProperties?: ServiceSpecificationCommercePropertiesDto | undefined;
|
|
2096
2275
|
constructor(data?: IServiceSpecificationDto);
|
|
2097
|
-
init(_data?: any): void;
|
|
2276
|
+
init?(_data?: any): void;
|
|
2098
2277
|
static fromJS(data: any): ServiceSpecificationDto;
|
|
2099
|
-
toJSON(data?: any): any;
|
|
2278
|
+
toJSON?(data?: any): any;
|
|
2100
2279
|
}
|
|
2101
2280
|
/** This is the base class that holds information about a whole service specification. */
|
|
2102
2281
|
export interface IServiceSpecificationDto {
|
|
@@ -2217,9 +2396,9 @@ export declare abstract class IElementDto implements IIElementDto {
|
|
|
2217
2396
|
catalogueReferences?: CatalogueReferenceDto[] | undefined;
|
|
2218
2397
|
protected _discriminator: string;
|
|
2219
2398
|
constructor(data?: IIElementDto);
|
|
2220
|
-
init(_data?: any): void;
|
|
2399
|
+
init?(_data?: any): void;
|
|
2221
2400
|
static fromJS(data: any): IElementDto;
|
|
2222
|
-
toJSON(data?: any): any;
|
|
2401
|
+
toJSON?(data?: any): any;
|
|
2223
2402
|
}
|
|
2224
2403
|
/** Base interface definition for elements within an ElementContainerBase. */
|
|
2225
2404
|
export interface IIElementDto {
|
|
@@ -2247,9 +2426,9 @@ export declare class CatalogueDto implements ICatalogueDto {
|
|
|
2247
2426
|
/** This property may hold additional information about the catalogue type. It is currently only used in GAEB XML exchange to carry detailed information about a catalogue type, but it's otherwise just a free text field. */
|
|
2248
2427
|
catalogueTypeDetail?: string | undefined;
|
|
2249
2428
|
constructor(data?: ICatalogueDto);
|
|
2250
|
-
init(_data?: any): void;
|
|
2429
|
+
init?(_data?: any): void;
|
|
2251
2430
|
static fromJS(data: any): CatalogueDto;
|
|
2252
|
-
toJSON(data?: any): any;
|
|
2431
|
+
toJSON?(data?: any): any;
|
|
2253
2432
|
}
|
|
2254
2433
|
/** This class describes an external catalogue. Catalogues, or collections, hold information to categorize and describe items. For example, the German DIN 276 cost group standards describe different types of costs for building projects. When referencing the DIN 276 catalogue and providing an item key or identifier, it is possible to reference data in this catalogue. */
|
|
2255
2434
|
export interface ICatalogueDto {
|
|
@@ -2290,9 +2469,9 @@ export declare class CatalogueReferenceDto implements ICatalogueReferenceDto {
|
|
|
2290
2469
|
/** This returns the referenced catalogue. Will return null if there is no reference or the catalogue is not present in the ProjectCatalogues. */
|
|
2291
2470
|
readonly catalogue?: CatalogueDto | undefined;
|
|
2292
2471
|
constructor(data?: ICatalogueReferenceDto);
|
|
2293
|
-
init(_data?: any): void;
|
|
2472
|
+
init?(_data?: any): void;
|
|
2294
2473
|
static fromJS(data: any): CatalogueReferenceDto;
|
|
2295
|
-
toJSON(data?: any): any;
|
|
2474
|
+
toJSON?(data?: any): any;
|
|
2296
2475
|
}
|
|
2297
2476
|
/** This class is used to link data between catalogues and objects. */
|
|
2298
2477
|
export interface ICatalogueReferenceDto {
|
|
@@ -2369,8 +2548,10 @@ export declare class PositionDto extends IElementDto implements IPositionDto {
|
|
|
2369
2548
|
serviceType: ServiceTypeDto;
|
|
2370
2549
|
/** This property describes additional information about a product being used within this Position. For example, a pipe position, per length unit, could be composed of different pipe segments, fitting and other accessory articles. */
|
|
2371
2550
|
productData?: ProductDataDto | undefined;
|
|
2372
|
-
/** Short description for this DescriptionBase element. */
|
|
2551
|
+
/** Short description for this DescriptionBase element. Please note that by default, this property takes precedence over the `HtmlShortText` property. If you want to convert from DTO objects, and you want to work with the `HtmlShortText` property, you need to set this property to null. */
|
|
2373
2552
|
shortText?: string | undefined;
|
|
2553
|
+
/** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. This property is used to store the short text in HTML format. If you want to convert from DTO objects, and you want to use this property, then you need to ensure that `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
2554
|
+
htmlShortText?: string | undefined;
|
|
2374
2555
|
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
2375
2556
|
longText?: string | undefined;
|
|
2376
2557
|
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
@@ -2419,6 +2600,8 @@ export declare class PositionDto extends IElementDto implements IPositionDto {
|
|
|
2419
2600
|
priceCatalogueData?: PriceCatalogueDataDto | undefined;
|
|
2420
2601
|
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties. */
|
|
2421
2602
|
ignoreProjectCataloguePropagation: boolean;
|
|
2603
|
+
/** A main position means that this position is important and should be highlighted in the user interface. Important meaning that is is usually a bigger part of the total sum of the services, or it needs special attention in another way. */
|
|
2604
|
+
isMainPosition: boolean;
|
|
2422
2605
|
constructor(data?: IPositionDto);
|
|
2423
2606
|
init(_data?: any): void;
|
|
2424
2607
|
static fromJS(data: any): PositionDto;
|
|
@@ -2486,8 +2669,10 @@ export interface IPositionDto extends IIElementDto {
|
|
|
2486
2669
|
serviceType: ServiceTypeDto;
|
|
2487
2670
|
/** This property describes additional information about a product being used within this Position. For example, a pipe position, per length unit, could be composed of different pipe segments, fitting and other accessory articles. */
|
|
2488
2671
|
productData?: IProductDataDto | undefined;
|
|
2489
|
-
/** Short description for this DescriptionBase element. */
|
|
2672
|
+
/** Short description for this DescriptionBase element. Please note that by default, this property takes precedence over the `HtmlShortText` property. If you want to convert from DTO objects, and you want to work with the `HtmlShortText` property, you need to set this property to null. */
|
|
2490
2673
|
shortText?: string | undefined;
|
|
2674
|
+
/** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. This property is used to store the short text in HTML format. If you want to convert from DTO objects, and you want to use this property, then you need to ensure that `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
2675
|
+
htmlShortText?: string | undefined;
|
|
2491
2676
|
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
2492
2677
|
longText?: string | undefined;
|
|
2493
2678
|
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
@@ -2536,6 +2721,8 @@ export interface IPositionDto extends IIElementDto {
|
|
|
2536
2721
|
priceCatalogueData?: IPriceCatalogueDataDto | undefined;
|
|
2537
2722
|
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties. */
|
|
2538
2723
|
ignoreProjectCataloguePropagation: boolean;
|
|
2724
|
+
/** A main position means that this position is important and should be highlighted in the user interface. Important meaning that is is usually a bigger part of the total sum of the services, or it needs special attention in another way. */
|
|
2725
|
+
isMainPosition: boolean;
|
|
2539
2726
|
}
|
|
2540
2727
|
/** Based on the PriceComponent, this class is responsible for labour time components. */
|
|
2541
2728
|
export declare class LabourPriceComponentDto implements ILabourPriceComponentDto {
|
|
@@ -2554,9 +2741,9 @@ export declare class LabourPriceComponentDto implements ILabourPriceComponentDto
|
|
|
2554
2741
|
/** These are Catalogues that are used within this PriceComponent. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
2555
2742
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
2556
2743
|
constructor(data?: ILabourPriceComponentDto);
|
|
2557
|
-
init(_data?: any): void;
|
|
2744
|
+
init?(_data?: any): void;
|
|
2558
2745
|
static fromJS(data: any): LabourPriceComponentDto;
|
|
2559
|
-
toJSON(data?: any): any;
|
|
2746
|
+
toJSON?(data?: any): any;
|
|
2560
2747
|
}
|
|
2561
2748
|
/** Based on the PriceComponent, this class is responsible for labour time components. */
|
|
2562
2749
|
export interface ILabourPriceComponentDto {
|
|
@@ -2592,9 +2779,9 @@ export declare class CalculationDto implements ICalculationDto {
|
|
|
2592
2779
|
/** Referenced catalogues for this Calculation. */
|
|
2593
2780
|
catalogueReferences?: CatalogueReferenceDto[] | undefined;
|
|
2594
2781
|
constructor(data?: ICalculationDto);
|
|
2595
|
-
init(_data?: any): void;
|
|
2782
|
+
init?(_data?: any): void;
|
|
2596
2783
|
static fromJS(data: any): CalculationDto;
|
|
2597
|
-
toJSON(data?: any): any;
|
|
2784
|
+
toJSON?(data?: any): any;
|
|
2598
2785
|
}
|
|
2599
2786
|
/** This class holds means to calculate mathematical expressions from given strings. */
|
|
2600
2787
|
export interface ICalculationDto {
|
|
@@ -2624,9 +2811,9 @@ export declare class PriceComponentDto implements IPriceComponentDto {
|
|
|
2624
2811
|
/** These are Catalogues that are used within this PriceComponent. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
2625
2812
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
2626
2813
|
constructor(data?: IPriceComponentDto);
|
|
2627
|
-
init(_data?: any): void;
|
|
2814
|
+
init?(_data?: any): void;
|
|
2628
2815
|
static fromJS(data: any): PriceComponentDto;
|
|
2629
|
-
toJSON(data?: any): any;
|
|
2816
|
+
toJSON?(data?: any): any;
|
|
2630
2817
|
}
|
|
2631
2818
|
/** This class provides means to store information about a price and it's composition. Note that this is referencing to a single price component, so for example a Position would have a list of PriceComponents, one for Material, one for Labour etc. */
|
|
2632
2819
|
export interface IPriceComponentDto {
|
|
@@ -2653,8 +2840,10 @@ export declare class SubDescriptionDto implements ISubDescriptionDto {
|
|
|
2653
2840
|
amountToBeEnteredByBidder: boolean;
|
|
2654
2841
|
/** Identifier for this SubDescription. */
|
|
2655
2842
|
identifier?: string | undefined;
|
|
2656
|
-
/** Short description for this DescriptionBase element. */
|
|
2843
|
+
/** Short description for this DescriptionBase element. Please note that by default, this property takes precedence over the `HtmlShortText` property. If you want to convert from DTO objects, and you want to work with the `HtmlShortText` property, you need to set this property to null. */
|
|
2657
2844
|
shortText?: string | undefined;
|
|
2845
|
+
/** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. This property is used to store the short text in HTML format. If you want to convert from DTO objects, and you want to use this property, then you need to ensure that `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
2846
|
+
htmlShortText?: string | undefined;
|
|
2658
2847
|
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
2659
2848
|
longText?: string | undefined;
|
|
2660
2849
|
/** If this is given, then the sub description has a different unit tag than the parent position. */
|
|
@@ -2672,12 +2861,10 @@ export declare class SubDescriptionDto implements ISubDescriptionDto {
|
|
|
2672
2861
|
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
2673
2862
|
descriptionId?: string | undefined;
|
|
2674
2863
|
readonly hasBidderCommentInHtmlLongText: boolean;
|
|
2675
|
-
elementType?: string | undefined;
|
|
2676
|
-
elementTypeDiscriminator?: string | undefined;
|
|
2677
2864
|
constructor(data?: ISubDescriptionDto);
|
|
2678
|
-
init(_data?: any): void;
|
|
2865
|
+
init?(_data?: any): void;
|
|
2679
2866
|
static fromJS(data: any): SubDescriptionDto;
|
|
2680
|
-
toJSON(data?: any): any;
|
|
2867
|
+
toJSON?(data?: any): any;
|
|
2681
2868
|
}
|
|
2682
2869
|
/** This is appended to a Position and is used to separate the complete Position into smaller amounts to be described separately, for example concrete walls could be attached to different building storeys. */
|
|
2683
2870
|
export interface ISubDescriptionDto {
|
|
@@ -2693,8 +2880,10 @@ export interface ISubDescriptionDto {
|
|
|
2693
2880
|
amountToBeEnteredByBidder: boolean;
|
|
2694
2881
|
/** Identifier for this SubDescription. */
|
|
2695
2882
|
identifier?: string | undefined;
|
|
2696
|
-
/** Short description for this DescriptionBase element. */
|
|
2883
|
+
/** Short description for this DescriptionBase element. Please note that by default, this property takes precedence over the `HtmlShortText` property. If you want to convert from DTO objects, and you want to work with the `HtmlShortText` property, you need to set this property to null. */
|
|
2697
2884
|
shortText?: string | undefined;
|
|
2885
|
+
/** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. This property is used to store the short text in HTML format. If you want to convert from DTO objects, and you want to use this property, then you need to ensure that `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
2886
|
+
htmlShortText?: string | undefined;
|
|
2698
2887
|
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
2699
2888
|
longText?: string | undefined;
|
|
2700
2889
|
/** If this is given, then the sub description has a different unit tag than the parent position. */
|
|
@@ -2712,8 +2901,6 @@ export interface ISubDescriptionDto {
|
|
|
2712
2901
|
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
2713
2902
|
descriptionId?: string | undefined;
|
|
2714
2903
|
hasBidderCommentInHtmlLongText: boolean;
|
|
2715
|
-
elementType?: string | undefined;
|
|
2716
|
-
elementTypeDiscriminator?: string | undefined;
|
|
2717
2904
|
}
|
|
2718
2905
|
/** Indicates the origin of an element. */
|
|
2719
2906
|
export declare enum AdditionTypeDto {
|
|
@@ -2730,9 +2917,9 @@ export declare class StandardizedDescriptionDto implements IStandardizedDescript
|
|
|
2730
2917
|
/** This is a special reference to the German STLB "Standardleistungsbuch Bau" reference. If this is used, the StandardReference property should not be set. */
|
|
2731
2918
|
stlbReference?: STLBReferenceDto | undefined;
|
|
2732
2919
|
constructor(data?: IStandardizedDescriptionDto);
|
|
2733
|
-
init(_data?: any): void;
|
|
2920
|
+
init?(_data?: any): void;
|
|
2734
2921
|
static fromJS(data: any): StandardizedDescriptionDto;
|
|
2735
|
-
toJSON(data?: any): any;
|
|
2922
|
+
toJSON?(data?: any): any;
|
|
2736
2923
|
}
|
|
2737
2924
|
/** This class represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
2738
2925
|
export interface IStandardizedDescriptionDto {
|
|
@@ -2765,9 +2952,9 @@ export declare class STLBReferenceDto implements ISTLBReferenceDto {
|
|
|
2765
2952
|
/** These keys may optionally be used to further reference multiple, specific items within the STLB */
|
|
2766
2953
|
keys?: STLBKeyDto[] | undefined;
|
|
2767
2954
|
constructor(data?: ISTLBReferenceDto);
|
|
2768
|
-
init(_data?: any): void;
|
|
2955
|
+
init?(_data?: any): void;
|
|
2769
2956
|
static fromJS(data: any): STLBReferenceDto;
|
|
2770
|
-
toJSON(data?: any): any;
|
|
2957
|
+
toJSON?(data?: any): any;
|
|
2771
2958
|
}
|
|
2772
2959
|
/** This class represents a specialized reference to the German STLB "Standardleistungsbuch Bau". The STLB is a commercial offering and describes common services in the construction sector. When this is used, this describes the exact type of a service via a reference to this standard */
|
|
2773
2960
|
export interface ISTLBReferenceDto {
|
|
@@ -2793,9 +2980,9 @@ export declare class STLBKeyDto implements ISTLBKeyDto {
|
|
|
2793
2980
|
/** This optional identifier further specifies the execution kind of the reference in the STLB standard. It maps to "ChVIdent" in GAEB XML */
|
|
2794
2981
|
kindIdentifier?: number | undefined;
|
|
2795
2982
|
constructor(data?: ISTLBKeyDto);
|
|
2796
|
-
init(_data?: any): void;
|
|
2983
|
+
init?(_data?: any): void;
|
|
2797
2984
|
static fromJS(data: any): STLBKeyDto;
|
|
2798
|
-
toJSON(data?: any): any;
|
|
2985
|
+
toJSON?(data?: any): any;
|
|
2799
2986
|
}
|
|
2800
2987
|
/** This class represents a single key reference within the German STLB "Standardleistungsbuch Bau" */
|
|
2801
2988
|
export interface ISTLBKeyDto {
|
|
@@ -2832,9 +3019,9 @@ export declare class ItemNumberDto implements IItemNumberDto {
|
|
|
2832
3019
|
/** This property indicates if this ItemNumber is attached to an object of the Position type. */
|
|
2833
3020
|
readonly isAttachedToPosition: boolean;
|
|
2834
3021
|
constructor(data?: IItemNumberDto);
|
|
2835
|
-
init(_data?: any): void;
|
|
3022
|
+
init?(_data?: any): void;
|
|
2836
3023
|
static fromJS(data: any): ItemNumberDto;
|
|
2837
|
-
toJSON(data?: any): any;
|
|
3024
|
+
toJSON?(data?: any): any;
|
|
2838
3025
|
}
|
|
2839
3026
|
/** This class represents as identifier of a certain service specification's element and is uniquely within the service specification. */
|
|
2840
3027
|
export interface IItemNumberDto {
|
|
@@ -2886,9 +3073,9 @@ export declare class ProductDataDto implements IProductDataDto {
|
|
|
2886
3073
|
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
2887
3074
|
htmlLongText?: string | undefined;
|
|
2888
3075
|
constructor(data?: IProductDataDto);
|
|
2889
|
-
init(_data?: any): void;
|
|
3076
|
+
init?(_data?: any): void;
|
|
2890
3077
|
static fromJS(data: any): ProductDataDto;
|
|
2891
|
-
toJSON(data?: any): any;
|
|
3078
|
+
toJSON?(data?: any): any;
|
|
2892
3079
|
}
|
|
2893
3080
|
/** This class represents data about products and their vendor */
|
|
2894
3081
|
export interface IProductDataDto {
|
|
@@ -2926,9 +3113,9 @@ export declare class ArticleDataDto implements IArticleDataDto {
|
|
|
2926
3113
|
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
2927
3114
|
htmlLongText?: string | undefined;
|
|
2928
3115
|
constructor(data?: IArticleDataDto);
|
|
2929
|
-
init(_data?: any): void;
|
|
3116
|
+
init?(_data?: any): void;
|
|
2930
3117
|
static fromJS(data: any): ArticleDataDto;
|
|
2931
|
-
toJSON(data?: any): any;
|
|
3118
|
+
toJSON?(data?: any): any;
|
|
2932
3119
|
}
|
|
2933
3120
|
/** This class represents a single article, usually used within ProductData */
|
|
2934
3121
|
export interface IArticleDataDto {
|
|
@@ -2962,9 +3149,9 @@ export declare class QuantityAssignmentDto implements IQuantityAssignmentDto {
|
|
|
2962
3149
|
/** Referenced catalogues for this QuantityAssignment. */
|
|
2963
3150
|
catalogueReferences?: CatalogueReferenceDto[] | undefined;
|
|
2964
3151
|
constructor(data?: IQuantityAssignmentDto);
|
|
2965
|
-
init(_data?: any): void;
|
|
3152
|
+
init?(_data?: any): void;
|
|
2966
3153
|
static fromJS(data: any): QuantityAssignmentDto;
|
|
2967
|
-
toJSON(data?: any): any;
|
|
3154
|
+
toJSON?(data?: any): any;
|
|
2968
3155
|
}
|
|
2969
3156
|
/** Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of their parent Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes. */
|
|
2970
3157
|
export interface IQuantityAssignmentDto {
|
|
@@ -2996,9 +3183,9 @@ export declare class CommercePropertiesDto implements ICommercePropertiesDto {
|
|
|
2996
3183
|
/** In a commerce exchange, this property is usually used to reference the base item number of an underlying phase 83 exchange file */
|
|
2997
3184
|
customerBaseItemNumber?: string | undefined;
|
|
2998
3185
|
constructor(data?: ICommercePropertiesDto);
|
|
2999
|
-
init(_data?: any): void;
|
|
3186
|
+
init?(_data?: any): void;
|
|
3000
3187
|
static fromJS(data: any): CommercePropertiesDto;
|
|
3001
|
-
toJSON(data?: any): any;
|
|
3188
|
+
toJSON?(data?: any): any;
|
|
3002
3189
|
}
|
|
3003
3190
|
/** This class holds specialized information that is relevant to trade or commerce based data exchange scenarios, e.g. between customers, vendors, suppliers and distributors. It is used when exporting to GAEB XML 9x exchange phases. */
|
|
3004
3191
|
export interface ICommercePropertiesDto {
|
|
@@ -3026,9 +3213,9 @@ export declare class ComplementedByQuantityDto implements IComplementedByQuantit
|
|
|
3026
3213
|
/** This is the reference to the Id of the Position that is complementing. This means it does NOT reference the base position but the one that contains the actual addition. */
|
|
3027
3214
|
complementingPositionId?: string | undefined;
|
|
3028
3215
|
constructor(data?: IComplementedByQuantityDto);
|
|
3029
|
-
init(_data?: any): void;
|
|
3216
|
+
init?(_data?: any): void;
|
|
3030
3217
|
static fromJS(data: any): ComplementedByQuantityDto;
|
|
3031
|
-
toJSON(data?: any): any;
|
|
3218
|
+
toJSON?(data?: any): any;
|
|
3032
3219
|
}
|
|
3033
3220
|
/** This class represents the linking to a complementary position with a specific quantity set. For example, Position 'A' could be complementing Position 'B' with a total quantity of 20 units */
|
|
3034
3221
|
export interface IComplementedByQuantityDto {
|
|
@@ -3043,7 +3230,7 @@ export declare class OenormPositionPropertiesDto implements IOenormPositionPrope
|
|
|
3043
3230
|
originCode: OenormOriginCodeDto;
|
|
3044
3231
|
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
3045
3232
|
openingTextIsFreeText: boolean;
|
|
3046
|
-
/** This indicates if the ÖNorm 'wesentliche position' mark is set */
|
|
3233
|
+
/** This indicates if the ÖNorm 'wesentliche position' mark is set. This should no longer be used, please use the IsMainPosition property on the parent position instead. */
|
|
3047
3234
|
isMainPosition: boolean;
|
|
3048
3235
|
/** This indicates if the ÖNorm position was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position is also the sole element inside it's parent group */
|
|
3049
3236
|
isUndividedPosition: boolean;
|
|
@@ -3052,9 +3239,9 @@ export declare class OenormPositionPropertiesDto implements IOenormPositionPrope
|
|
|
3052
3239
|
/** In some ÖNorm formats, the short text can have it's own addition, so the text is split up in OenormShortText and OenormShortTextAddition To serialize this, either the ShortText property of the parent position needs to be null, or OenormShortText ' ' OenormShortTextAddition needs to match the ShortText. */
|
|
3053
3240
|
oenormShortTextAddition?: string | undefined;
|
|
3054
3241
|
constructor(data?: IOenormPositionPropertiesDto);
|
|
3055
|
-
init(_data?: any): void;
|
|
3242
|
+
init?(_data?: any): void;
|
|
3056
3243
|
static fromJS(data: any): OenormPositionPropertiesDto;
|
|
3057
|
-
toJSON(data?: any): any;
|
|
3244
|
+
toJSON?(data?: any): any;
|
|
3058
3245
|
}
|
|
3059
3246
|
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class. */
|
|
3060
3247
|
export interface IOenormPositionPropertiesDto {
|
|
@@ -3062,7 +3249,7 @@ export interface IOenormPositionPropertiesDto {
|
|
|
3062
3249
|
originCode: OenormOriginCodeDto;
|
|
3063
3250
|
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
3064
3251
|
openingTextIsFreeText: boolean;
|
|
3065
|
-
/** This indicates if the ÖNorm 'wesentliche position' mark is set */
|
|
3252
|
+
/** This indicates if the ÖNorm 'wesentliche position' mark is set. This should no longer be used, please use the IsMainPosition property on the parent position instead. */
|
|
3066
3253
|
isMainPosition: boolean;
|
|
3067
3254
|
/** This indicates if the ÖNorm position was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position is also the sole element inside it's parent group */
|
|
3068
3255
|
isUndividedPosition: boolean;
|
|
@@ -3109,9 +3296,9 @@ export declare class PositionHoldOutPropertiesDto implements IPositionHoldOutPro
|
|
|
3109
3296
|
/** References to base positions */
|
|
3110
3297
|
basePositionReferences?: string[] | undefined;
|
|
3111
3298
|
constructor(data?: IPositionHoldOutPropertiesDto);
|
|
3112
|
-
init(_data?: any): void;
|
|
3299
|
+
init?(_data?: any): void;
|
|
3113
3300
|
static fromJS(data: any): PositionHoldOutPropertiesDto;
|
|
3114
|
-
toJSON(data?: any): any;
|
|
3301
|
+
toJSON?(data?: any): any;
|
|
3115
3302
|
}
|
|
3116
3303
|
/** This class holds properties that describe retention types in position. Retention / hold out usually means that a service is provided and kept available for a specific amount of time, e.g. fences on a construction site */
|
|
3117
3304
|
export interface IPositionHoldOutPropertiesDto {
|
|
@@ -3159,9 +3346,9 @@ export declare class PriceCatalogueDataDto implements IPriceCatalogueDataDto {
|
|
|
3159
3346
|
/** The average wage price */
|
|
3160
3347
|
wagePriceAverage?: number | undefined;
|
|
3161
3348
|
constructor(data?: IPriceCatalogueDataDto);
|
|
3162
|
-
init(_data?: any): void;
|
|
3349
|
+
init?(_data?: any): void;
|
|
3163
3350
|
static fromJS(data: any): PriceCatalogueDataDto;
|
|
3164
|
-
toJSON(data?: any): any;
|
|
3351
|
+
toJSON?(data?: any): any;
|
|
3165
3352
|
}
|
|
3166
3353
|
/** Price catalogue data represents assumed or estimated prices from a catalogue source */
|
|
3167
3354
|
export interface IPriceCatalogueDataDto {
|
|
@@ -3210,8 +3397,10 @@ export declare class NoteTextDto extends IElementDto implements INoteTextDto {
|
|
|
3210
3397
|
isOpeningText: boolean;
|
|
3211
3398
|
/** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special closing text at the end of the project. For Example, in GAEB XML, this would map to the GAEB.AddText. Typically, such texts are used to describe project wide finishing descriptions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
|
|
3212
3399
|
isClosingText: boolean;
|
|
3213
|
-
/** Short description for this DescriptionBase element. */
|
|
3400
|
+
/** Short description for this DescriptionBase element. Please note that by default, this property takes precedence over the `HtmlShortText` property. If you want to convert from DTO objects, and you want to work with the `HtmlShortText` property, you need to set this property to null. */
|
|
3214
3401
|
shortText?: string | undefined;
|
|
3402
|
+
/** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. This property is used to store the short text in HTML format. If you want to convert from DTO objects, and you want to use this property, then you need to ensure that `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
3403
|
+
htmlShortText?: string | undefined;
|
|
3215
3404
|
/** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
|
|
3216
3405
|
additionType: AdditionTypeDto;
|
|
3217
3406
|
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
@@ -3239,8 +3428,10 @@ export interface INoteTextDto extends IIElementDto {
|
|
|
3239
3428
|
isOpeningText: boolean;
|
|
3240
3429
|
/** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special closing text at the end of the project. For Example, in GAEB XML, this would map to the GAEB.AddText. Typically, such texts are used to describe project wide finishing descriptions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
|
|
3241
3430
|
isClosingText: boolean;
|
|
3242
|
-
/** Short description for this DescriptionBase element. */
|
|
3431
|
+
/** Short description for this DescriptionBase element. Please note that by default, this property takes precedence over the `HtmlShortText` property. If you want to convert from DTO objects, and you want to work with the `HtmlShortText` property, you need to set this property to null. */
|
|
3243
3432
|
shortText?: string | undefined;
|
|
3433
|
+
/** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. This property is used to store the short text in HTML format. If you want to convert from DTO objects, and you want to use this property, then you need to ensure that `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
3434
|
+
htmlShortText?: string | undefined;
|
|
3244
3435
|
/** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
|
|
3245
3436
|
additionType: AdditionTypeDto;
|
|
3246
3437
|
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
@@ -3262,15 +3453,23 @@ export interface INoteTextDto extends IIElementDto {
|
|
|
3262
3453
|
export declare class OenormNoteTextPropertiesDto implements IOenormNoteTextPropertiesDto {
|
|
3263
3454
|
/** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
|
|
3264
3455
|
originCode: OenormOriginCodeDto;
|
|
3456
|
+
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
3457
|
+
openingTextIsFreeText: boolean;
|
|
3458
|
+
/** This indicates if the ÖNorm position / note text was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position / note text is also the sole element inside it's parent group */
|
|
3459
|
+
isUndividedPosition: boolean;
|
|
3265
3460
|
constructor(data?: IOenormNoteTextPropertiesDto);
|
|
3266
|
-
init(_data?: any): void;
|
|
3461
|
+
init?(_data?: any): void;
|
|
3267
3462
|
static fromJS(data: any): OenormNoteTextPropertiesDto;
|
|
3268
|
-
toJSON(data?: any): any;
|
|
3463
|
+
toJSON?(data?: any): any;
|
|
3269
3464
|
}
|
|
3270
3465
|
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
|
|
3271
3466
|
export interface IOenormNoteTextPropertiesDto {
|
|
3272
3467
|
/** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
|
|
3273
3468
|
originCode: OenormOriginCodeDto;
|
|
3469
|
+
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
3470
|
+
openingTextIsFreeText: boolean;
|
|
3471
|
+
/** This indicates if the ÖNorm position / note text was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position / note text is also the sole element inside it's parent group */
|
|
3472
|
+
isUndividedPosition: boolean;
|
|
3274
3473
|
}
|
|
3275
3474
|
/** This is a grouping IElement that holds other IElements within. */
|
|
3276
3475
|
export declare class ServiceSpecificationGroupDto extends IElementDto implements IServiceSpecificationGroupDto {
|
|
@@ -3423,9 +3622,9 @@ export declare class GrossPriceComponentDto implements IGrossPriceComponentDto {
|
|
|
3423
3622
|
/** The total tax amount for all components of a given tax rate, after applied deductions. */
|
|
3424
3623
|
readonly totalTaxDeducted: number;
|
|
3425
3624
|
constructor(data?: IGrossPriceComponentDto);
|
|
3426
|
-
init(_data?: any): void;
|
|
3625
|
+
init?(_data?: any): void;
|
|
3427
3626
|
static fromJS(data: any): GrossPriceComponentDto;
|
|
3428
|
-
toJSON(data?: any): any;
|
|
3627
|
+
toJSON?(data?: any): any;
|
|
3429
3628
|
}
|
|
3430
3629
|
/** This is used in an ElementContainerBase to hold the price composition. */
|
|
3431
3630
|
export interface IGrossPriceComponentDto {
|
|
@@ -3453,9 +3652,9 @@ export declare class OenormPropertiesDto implements IOenormPropertiesDto {
|
|
|
3453
3652
|
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
3454
3653
|
openingTextIsFreeText: boolean;
|
|
3455
3654
|
constructor(data?: IOenormPropertiesDto);
|
|
3456
|
-
init(_data?: any): void;
|
|
3655
|
+
init?(_data?: any): void;
|
|
3457
3656
|
static fromJS(data: any): OenormPropertiesDto;
|
|
3458
|
-
toJSON(data?: any): any;
|
|
3657
|
+
toJSON?(data?: any): any;
|
|
3459
3658
|
}
|
|
3460
3659
|
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
|
|
3461
3660
|
export interface IOenormPropertiesDto {
|
|
@@ -3501,9 +3700,9 @@ export declare class PriceInformationDto implements IPriceInformationDto {
|
|
|
3501
3700
|
/** Trade discounts for offered in this ServiceSpecification. */
|
|
3502
3701
|
tradeDiscounts?: TradeDiscountDto[] | undefined;
|
|
3503
3702
|
constructor(data?: IPriceInformationDto);
|
|
3504
|
-
init(_data?: any): void;
|
|
3703
|
+
init?(_data?: any): void;
|
|
3505
3704
|
static fromJS(data: any): PriceInformationDto;
|
|
3506
|
-
toJSON(data?: any): any;
|
|
3705
|
+
toJSON?(data?: any): any;
|
|
3507
3706
|
}
|
|
3508
3707
|
/** Holds global price information for a ServiceSpecification */
|
|
3509
3708
|
export interface IPriceInformationDto {
|
|
@@ -3531,9 +3730,9 @@ export declare class TradeDiscountDto implements ITradeDiscountDto {
|
|
|
3531
3730
|
/** The rate of the trade discount. */
|
|
3532
3731
|
rate: number;
|
|
3533
3732
|
constructor(data?: ITradeDiscountDto);
|
|
3534
|
-
init(_data?: any): void;
|
|
3733
|
+
init?(_data?: any): void;
|
|
3535
3734
|
static fromJS(data: any): TradeDiscountDto;
|
|
3536
|
-
toJSON(data?: any): any;
|
|
3735
|
+
toJSON?(data?: any): any;
|
|
3537
3736
|
}
|
|
3538
3737
|
/** This class holds information about offered trade discounts (Skonto in German) */
|
|
3539
3738
|
export interface ITradeDiscountDto {
|
|
@@ -3551,9 +3750,9 @@ export declare class WarrantyDurationDto implements IWarrantyDurationDto {
|
|
|
3551
3750
|
/** The unit of the duration */
|
|
3552
3751
|
unit: DurationUnitDto;
|
|
3553
3752
|
constructor(data?: IWarrantyDurationDto);
|
|
3554
|
-
init(_data?: any): void;
|
|
3753
|
+
init?(_data?: any): void;
|
|
3555
3754
|
static fromJS(data: any): WarrantyDurationDto;
|
|
3556
|
-
toJSON(data?: any): any;
|
|
3755
|
+
toJSON?(data?: any): any;
|
|
3557
3756
|
}
|
|
3558
3757
|
/** This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g. 5 Months */
|
|
3559
3758
|
export interface IWarrantyDurationDto {
|
|
@@ -3594,9 +3793,9 @@ export declare class ServiceSpecificationCommercePropertiesDto implements IServi
|
|
|
3594
3793
|
/** The type of the price inquiry. */
|
|
3595
3794
|
inquiryType: CommerceInquiryTypeDto;
|
|
3596
3795
|
constructor(data?: IServiceSpecificationCommercePropertiesDto);
|
|
3597
|
-
init(_data?: any): void;
|
|
3796
|
+
init?(_data?: any): void;
|
|
3598
3797
|
static fromJS(data: any): ServiceSpecificationCommercePropertiesDto;
|
|
3599
|
-
toJSON(data?: any): any;
|
|
3798
|
+
toJSON?(data?: any): any;
|
|
3600
3799
|
}
|
|
3601
3800
|
/** This class represents properties used in commerce exchange scenarios */
|
|
3602
3801
|
export interface IServiceSpecificationCommercePropertiesDto {
|
|
@@ -3639,9 +3838,9 @@ export declare class ApiError implements IApiError {
|
|
|
3639
3838
|
[key: string]: string[];
|
|
3640
3839
|
} | undefined;
|
|
3641
3840
|
constructor(data?: IApiError);
|
|
3642
|
-
init(_data?: any): void;
|
|
3841
|
+
init?(_data?: any): void;
|
|
3643
3842
|
static fromJS(data: any): ApiError;
|
|
3644
|
-
toJSON(data?: any): any;
|
|
3843
|
+
toJSON?(data?: any): any;
|
|
3645
3844
|
}
|
|
3646
3845
|
/** Data transfer class to convey api errors */
|
|
3647
3846
|
export interface IApiError {
|
|
@@ -3658,9 +3857,9 @@ no elements. */
|
|
|
3658
3857
|
/** The flattened elements of the project. */
|
|
3659
3858
|
elements?: FlatElementDto[] | undefined;
|
|
3660
3859
|
constructor(data?: IFlatAvaProject);
|
|
3661
|
-
init(_data?: any): void;
|
|
3860
|
+
init?(_data?: any): void;
|
|
3662
3861
|
static fromJS(data: any): FlatAvaProject;
|
|
3663
|
-
toJSON(data?: any): any;
|
|
3862
|
+
toJSON?(data?: any): any;
|
|
3664
3863
|
}
|
|
3665
3864
|
/** This model contains a flattened represention of an AVA project, which makes it easy to use in systems that expect elements in a list form. */
|
|
3666
3865
|
export interface IFlatAvaProject {
|
|
@@ -3670,7 +3869,7 @@ no elements. */
|
|
|
3670
3869
|
/** The flattened elements of the project. */
|
|
3671
3870
|
elements?: IFlatElementDto[] | undefined;
|
|
3672
3871
|
}
|
|
3673
|
-
/**
|
|
3872
|
+
/** The flattened element of the project. */
|
|
3674
3873
|
export declare class FlatElementDto implements IFlatElementDto {
|
|
3675
3874
|
/** If this is not null, then this contains the id of the previous
|
|
3676
3875
|
element in the hierarchy on the same level. */
|
|
@@ -3681,11 +3880,11 @@ element. */
|
|
|
3681
3880
|
/** The element itself. */
|
|
3682
3881
|
element?: IElementDto | undefined;
|
|
3683
3882
|
constructor(data?: IFlatElementDto);
|
|
3684
|
-
init(_data?: any): void;
|
|
3883
|
+
init?(_data?: any): void;
|
|
3685
3884
|
static fromJS(data: any): FlatElementDto;
|
|
3686
|
-
toJSON(data?: any): any;
|
|
3885
|
+
toJSON?(data?: any): any;
|
|
3687
3886
|
}
|
|
3688
|
-
/**
|
|
3887
|
+
/** The flattened element of the project. */
|
|
3689
3888
|
export interface IFlatElementDto {
|
|
3690
3889
|
/** If this is not null, then this contains the id of the previous
|
|
3691
3890
|
element in the hierarchy on the same level. */
|
|
@@ -3727,7 +3926,10 @@ export declare enum DestinationOenormType {
|
|
|
3727
3926
|
Lv2009 = "Lv2009",
|
|
3728
3927
|
Lb2009 = "Lb2009",
|
|
3729
3928
|
Lv2021 = "Lv2021",
|
|
3730
|
-
Lb2021 = "Lb2021"
|
|
3929
|
+
Lb2021 = "Lb2021",
|
|
3930
|
+
Re2009 = "Re2009",
|
|
3931
|
+
Re2015 = "Re2015",
|
|
3932
|
+
Re2021 = "Re2021"
|
|
3731
3933
|
}
|
|
3732
3934
|
/** Represents valid REB target types */
|
|
3733
3935
|
export declare enum DestinationRebType {
|
|
@@ -3754,6 +3956,46 @@ export declare enum UglDestinationVersion {
|
|
|
3754
3956
|
export declare enum IdsConnectVersion {
|
|
3755
3957
|
V2_5 = "V2_5"
|
|
3756
3958
|
}
|
|
3959
|
+
/** This represents the result of merging two AVA projects. */
|
|
3960
|
+
export declare class GetProjectMergeResult implements IGetProjectMergeResult {
|
|
3961
|
+
/** The resulting merged project. */
|
|
3962
|
+
mergedProject?: ProjectDto | undefined;
|
|
3963
|
+
/** Elements that were present in the source project, but could not be matched to any element in the target project. */
|
|
3964
|
+
nonMatchedSourceElements?: IElementDto[] | undefined;
|
|
3965
|
+
/** Elements that were present in the target project, but could not be matched to any element in the source project. */
|
|
3966
|
+
nonMatchedTargetElements?: IElementDto[] | undefined;
|
|
3967
|
+
constructor(data?: IGetProjectMergeResult);
|
|
3968
|
+
init?(_data?: any): void;
|
|
3969
|
+
static fromJS(data: any): GetProjectMergeResult;
|
|
3970
|
+
toJSON?(data?: any): any;
|
|
3971
|
+
}
|
|
3972
|
+
/** This represents the result of merging two AVA projects. */
|
|
3973
|
+
export interface IGetProjectMergeResult {
|
|
3974
|
+
/** The resulting merged project. */
|
|
3975
|
+
mergedProject?: IProjectDto | undefined;
|
|
3976
|
+
/** Elements that were present in the source project, but could not be matched to any element in the target project. */
|
|
3977
|
+
nonMatchedSourceElements?: IElementDto[] | undefined;
|
|
3978
|
+
/** Elements that were present in the target project, but could not be matched to any element in the source project. */
|
|
3979
|
+
nonMatchedTargetElements?: IElementDto[] | undefined;
|
|
3980
|
+
}
|
|
3981
|
+
/** This model represents the configuration needed to merge two AVA projects. */
|
|
3982
|
+
export declare class PostAvaProjectMerge implements IPostAvaProjectMerge {
|
|
3983
|
+
/** The source project from which to take prices and text additions. */
|
|
3984
|
+
sourceProject?: ProjectDto | undefined;
|
|
3985
|
+
/** The target project which will keep its structure and receive prices and text additions from the source project. */
|
|
3986
|
+
targetProject?: ProjectDto | undefined;
|
|
3987
|
+
constructor(data?: IPostAvaProjectMerge);
|
|
3988
|
+
init?(_data?: any): void;
|
|
3989
|
+
static fromJS(data: any): PostAvaProjectMerge;
|
|
3990
|
+
toJSON?(data?: any): any;
|
|
3991
|
+
}
|
|
3992
|
+
/** This model represents the configuration needed to merge two AVA projects. */
|
|
3993
|
+
export interface IPostAvaProjectMerge {
|
|
3994
|
+
/** The source project from which to take prices and text additions. */
|
|
3995
|
+
sourceProject?: IProjectDto | undefined;
|
|
3996
|
+
/** The target project which will keep its structure and receive prices and text additions from the source project. */
|
|
3997
|
+
targetProject?: IProjectDto | undefined;
|
|
3998
|
+
}
|
|
3757
3999
|
/** Indicates the status of the AVACloud service */
|
|
3758
4000
|
export declare class GetStatus implements IGetStatus {
|
|
3759
4001
|
/** If any problems in the service health are known, this is set to false */
|
|
@@ -3763,9 +4005,9 @@ export declare class GetStatus implements IGetStatus {
|
|
|
3763
4005
|
/** The environment of the current instance */
|
|
3764
4006
|
environment?: string | undefined;
|
|
3765
4007
|
constructor(data?: IGetStatus);
|
|
3766
|
-
init(_data?: any): void;
|
|
4008
|
+
init?(_data?: any): void;
|
|
3767
4009
|
static fromJS(data: any): GetStatus;
|
|
3768
|
-
toJSON(data?: any): any;
|
|
4010
|
+
toJSON?(data?: any): any;
|
|
3769
4011
|
}
|
|
3770
4012
|
/** Indicates the status of the AVACloud service */
|
|
3771
4013
|
export interface IGetStatus {
|
|
@@ -3787,9 +4029,9 @@ export declare class ValidationResult implements IValidationResult {
|
|
|
3787
4029
|
/** Name of the validated file */
|
|
3788
4030
|
fileName?: string | undefined;
|
|
3789
4031
|
constructor(data?: IValidationResult);
|
|
3790
|
-
init(_data?: any): void;
|
|
4032
|
+
init?(_data?: any): void;
|
|
3791
4033
|
static fromJS(data: any): ValidationResult;
|
|
3792
|
-
toJSON(data?: any): any;
|
|
4034
|
+
toJSON?(data?: any): any;
|
|
3793
4035
|
}
|
|
3794
4036
|
/** This class represents the result of a validation operation */
|
|
3795
4037
|
export interface IValidationResult {
|
|
@@ -3819,9 +4061,9 @@ may be found in other properties of this class, depending on the check. */
|
|
|
3819
4061
|
/** For CheckType of types ProjectValidation */
|
|
3820
4062
|
projectValidationCheckDetails?: ProjectValidationCheckDetails | undefined;
|
|
3821
4063
|
constructor(data?: IValidationCheckResult);
|
|
3822
|
-
init(_data?: any): void;
|
|
4064
|
+
init?(_data?: any): void;
|
|
3823
4065
|
static fromJS(data: any): ValidationCheckResult;
|
|
3824
|
-
toJSON(data?: any): any;
|
|
4066
|
+
toJSON?(data?: any): any;
|
|
3825
4067
|
}
|
|
3826
4068
|
/** This class models the results of a single check performed during a validation action */
|
|
3827
4069
|
export interface IValidationCheckResult {
|
|
@@ -3852,16 +4094,17 @@ export declare enum ValidationCheckType {
|
|
|
3852
4094
|
General = "General",
|
|
3853
4095
|
XmlSchemaCheck = "XmlSchemaCheck",
|
|
3854
4096
|
ObjectValidation = "ObjectValidation",
|
|
3855
|
-
ProjectValidation = "ProjectValidation"
|
|
4097
|
+
ProjectValidation = "ProjectValidation",
|
|
4098
|
+
LineValidation = "LineValidation"
|
|
3856
4099
|
}
|
|
3857
4100
|
/** Basic information about Object check validation details, commonly used when checking GAEB 2000 files */
|
|
3858
4101
|
export declare class ObjectValidationCheckDetails implements IObjectValidationCheckDetails {
|
|
3859
4102
|
/** The path under which the element with error was found. */
|
|
3860
4103
|
elementPath?: string | undefined;
|
|
3861
4104
|
constructor(data?: IObjectValidationCheckDetails);
|
|
3862
|
-
init(_data?: any): void;
|
|
4105
|
+
init?(_data?: any): void;
|
|
3863
4106
|
static fromJS(data: any): ObjectValidationCheckDetails;
|
|
3864
|
-
toJSON(data?: any): any;
|
|
4107
|
+
toJSON?(data?: any): any;
|
|
3865
4108
|
}
|
|
3866
4109
|
/** Basic information about Object check validation details, commonly used when checking GAEB 2000 files */
|
|
3867
4110
|
export interface IObjectValidationCheckDetails {
|
|
@@ -3874,10 +4117,13 @@ export declare class XmlSchemaValidationCheckDetails implements IXmlSchemaValida
|
|
|
3874
4117
|
lineNumber: number;
|
|
3875
4118
|
/** The position in the line */
|
|
3876
4119
|
linePosition: number;
|
|
4120
|
+
/** Official data point identifier for XRechnung values, e.g. `BT-1`
|
|
4121
|
+
Should be null for other data types, e.g. GAEB or ÖNorm */
|
|
4122
|
+
invoiceDataPointId?: string | undefined;
|
|
3877
4123
|
constructor(data?: IXmlSchemaValidationCheckDetails);
|
|
3878
|
-
init(_data?: any): void;
|
|
4124
|
+
init?(_data?: any): void;
|
|
3879
4125
|
static fromJS(data: any): XmlSchemaValidationCheckDetails;
|
|
3880
|
-
toJSON(data?: any): any;
|
|
4126
|
+
toJSON?(data?: any): any;
|
|
3881
4127
|
}
|
|
3882
4128
|
/** Check details for an XML schema validation result */
|
|
3883
4129
|
export interface IXmlSchemaValidationCheckDetails {
|
|
@@ -3885,15 +4131,18 @@ export interface IXmlSchemaValidationCheckDetails {
|
|
|
3885
4131
|
lineNumber: number;
|
|
3886
4132
|
/** The position in the line */
|
|
3887
4133
|
linePosition: number;
|
|
4134
|
+
/** Official data point identifier for XRechnung values, e.g. `BT-1`
|
|
4135
|
+
Should be null for other data types, e.g. GAEB or ÖNorm */
|
|
4136
|
+
invoiceDataPointId?: string | undefined;
|
|
3888
4137
|
}
|
|
3889
4138
|
/** Check details specificly for checking ProjectDto objects */
|
|
3890
4139
|
export declare class ProjectValidationCheckDetails implements IProjectValidationCheckDetails {
|
|
3891
4140
|
/** The id of the element */
|
|
3892
4141
|
elementId: string;
|
|
3893
4142
|
constructor(data?: IProjectValidationCheckDetails);
|
|
3894
|
-
init(_data?: any): void;
|
|
4143
|
+
init?(_data?: any): void;
|
|
3895
4144
|
static fromJS(data: any): ProjectValidationCheckDetails;
|
|
3896
|
-
toJSON(data?: any): any;
|
|
4145
|
+
toJSON?(data?: any): any;
|
|
3897
4146
|
}
|
|
3898
4147
|
/** Check details specificly for checking ProjectDto objects */
|
|
3899
4148
|
export interface IProjectValidationCheckDetails {
|
|
@@ -3904,12 +4153,14 @@ export interface IProjectValidationCheckDetails {
|
|
|
3904
4153
|
export declare enum ValidationType {
|
|
3905
4154
|
Project = "Project",
|
|
3906
4155
|
Gaeb = "Gaeb",
|
|
3907
|
-
Oenorm = "Oenorm"
|
|
4156
|
+
Oenorm = "Oenorm",
|
|
4157
|
+
XRechnung = "XRechnung"
|
|
3908
4158
|
}
|
|
3909
4159
|
/** This enum represents the source type for a file based validation operation */
|
|
3910
4160
|
export declare enum FileValidationSourceType {
|
|
3911
4161
|
Gaeb = "Gaeb",
|
|
3912
|
-
Oenorm = "Oenorm"
|
|
4162
|
+
Oenorm = "Oenorm",
|
|
4163
|
+
XRechnung = "XRechnung"
|
|
3913
4164
|
}
|
|
3914
4165
|
/** Options for validating an AVA project */
|
|
3915
4166
|
export declare class PostAvaProjectValidationSourceOptions implements IPostAvaProjectValidationSourceOptions {
|
|
@@ -3933,9 +4184,9 @@ must be set in the appropriate properties as well. */
|
|
|
3933
4184
|
/** Options for conversion to GAEB. Should be given if ValidationType is set to GAEB. */
|
|
3934
4185
|
gaebDestinationOptions?: PostGaebDestinationOptions | undefined;
|
|
3935
4186
|
constructor(data?: IPostAvaProjectValidationSourceOptions);
|
|
3936
|
-
init(_data?: any): void;
|
|
4187
|
+
init?(_data?: any): void;
|
|
3937
4188
|
static fromJS(data: any): PostAvaProjectValidationSourceOptions;
|
|
3938
|
-
toJSON(data?: any): any;
|
|
4189
|
+
toJSON?(data?: any): any;
|
|
3939
4190
|
}
|
|
3940
4191
|
/** Options for validating an AVA project */
|
|
3941
4192
|
export interface IPostAvaProjectValidationSourceOptions {
|
|
@@ -3967,9 +4218,9 @@ The operation will not have any effect if either an item number schema
|
|
|
3967
4218
|
is already present, or if any of the elements already has an item number. */
|
|
3968
4219
|
tryAutoGenerateItemNumbersAndSchema: boolean;
|
|
3969
4220
|
constructor(data?: IPostAvaSourceOptions);
|
|
3970
|
-
init(_data?: any): void;
|
|
4221
|
+
init?(_data?: any): void;
|
|
3971
4222
|
static fromJS(data: any): PostAvaSourceOptions;
|
|
3972
|
-
toJSON(data?: any): any;
|
|
4223
|
+
toJSON?(data?: any): any;
|
|
3973
4224
|
}
|
|
3974
4225
|
/** Options for conversions from AVA */
|
|
3975
4226
|
export interface IPostAvaSourceOptions {
|
|
@@ -3995,9 +4246,9 @@ might fail in case some text content contains characters that are not allowed in
|
|
|
3995
4246
|
Defaults to true. */
|
|
3996
4247
|
removeUnprintableCharactersFromTexts: boolean;
|
|
3997
4248
|
constructor(data?: IPostOenormDestinationOptions);
|
|
3998
|
-
init(_data?: any): void;
|
|
4249
|
+
init?(_data?: any): void;
|
|
3999
4250
|
static fromJS(data: any): PostOenormDestinationOptions;
|
|
4000
|
-
toJSON(data?: any): any;
|
|
4251
|
+
toJSON?(data?: any): any;
|
|
4001
4252
|
}
|
|
4002
4253
|
/** Options for conversions to Oenorm */
|
|
4003
4254
|
export interface IPostOenormDestinationOptions {
|
|
@@ -4052,9 +4303,9 @@ and not lead to any schema being generated. It is recommended to enable this opt
|
|
|
4052
4303
|
reasons. */
|
|
4053
4304
|
treatNullItemNumberSchemaAsInvalid: boolean;
|
|
4054
4305
|
constructor(data?: IPostGaebDestinationOptions);
|
|
4055
|
-
init(_data?: any): void;
|
|
4306
|
+
init?(_data?: any): void;
|
|
4056
4307
|
static fromJS(data: any): PostGaebDestinationOptions;
|
|
4057
|
-
toJSON(data?: any): any;
|
|
4308
|
+
toJSON?(data?: any): any;
|
|
4058
4309
|
}
|
|
4059
4310
|
/** Options for conversions to GAEB */
|
|
4060
4311
|
export interface IPostGaebDestinationOptions {
|
|
@@ -4095,101 +4346,163 @@ reasons. */
|
|
|
4095
4346
|
}
|
|
4096
4347
|
/** This class represents an invoice */
|
|
4097
4348
|
export declare class Invoice implements IInvoice {
|
|
4098
|
-
/**
|
|
4349
|
+
/** BT-1
|
|
4350
|
+
The number of the invoice */
|
|
4099
4351
|
invoiceNumber?: string | undefined;
|
|
4100
|
-
/**
|
|
4352
|
+
/** BT-2
|
|
4353
|
+
The date of the invoice */
|
|
4101
4354
|
invoiceDate?: Date | undefined;
|
|
4102
|
-
/**
|
|
4355
|
+
/** BT-3
|
|
4356
|
+
The type of the invoice */
|
|
4103
4357
|
invoiceType?: InvoiceType | undefined;
|
|
4104
|
-
/**
|
|
4358
|
+
/** BT-5
|
|
4359
|
+
The three letter ISO currency code */
|
|
4105
4360
|
currencyCode?: string | undefined;
|
|
4106
|
-
/**
|
|
4361
|
+
/** BT-9
|
|
4362
|
+
Until when the payment is due */
|
|
4107
4363
|
paymentDueDate?: Date | undefined;
|
|
4108
4364
|
/** An object holding reference used in this invoice */
|
|
4109
4365
|
references?: References | undefined;
|
|
4110
|
-
/**
|
|
4366
|
+
/** BT-20
|
|
4367
|
+
A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4111
4368
|
paymentTerms?: string | undefined;
|
|
4112
|
-
/**
|
|
4369
|
+
/** If the PaymentTerms are present and in a correct format, this read-only property
|
|
4370
|
+
can be used to get the actual parsed payment terms in a deserialized and structured format. This will
|
|
4371
|
+
be null if PaymentTerms are not present or not in the correct format */
|
|
4372
|
+
parsedPaymentTerms?: PaymentTerm[] | undefined;
|
|
4373
|
+
/** BG-3
|
|
4374
|
+
In case of partial or final invoices, it's possible to reference the previous invoice numbers */
|
|
4113
4375
|
previousInvoices?: PreviousInvoice[] | undefined;
|
|
4114
|
-
/**
|
|
4376
|
+
/** BG-7
|
|
4377
|
+
Information about the buyer */
|
|
4115
4378
|
buyer?: Organization | undefined;
|
|
4116
|
-
/**
|
|
4379
|
+
/** BG-4
|
|
4380
|
+
Information about the seller */
|
|
4117
4381
|
seller?: Organization | undefined;
|
|
4118
|
-
/**
|
|
4382
|
+
/** BG-11
|
|
4383
|
+
Information about the sellers tax representative */
|
|
4384
|
+
sellerTaxRepresentative?: Organization | undefined;
|
|
4385
|
+
/** BG-10
|
|
4386
|
+
A payee is someone who receives the payment that is different from the seller */
|
|
4119
4387
|
payee?: Payee | undefined;
|
|
4120
|
-
/**
|
|
4121
|
-
|
|
4388
|
+
/** BG-1
|
|
4389
|
+
If present, this is an unstructured text that can be used to give additional information
|
|
4390
|
+
about the invoice. Field BG-1 */
|
|
4122
4391
|
invoiceNotes?: InvoiceNote[] | undefined;
|
|
4123
|
-
/**
|
|
4392
|
+
/** BG-14
|
|
4393
|
+
The period during which the services or goods were delivered */
|
|
4124
4394
|
invoicePeriod?: InvoicePeriod | undefined;
|
|
4125
|
-
/**
|
|
4395
|
+
/** BG-13
|
|
4396
|
+
Information about the delivery
|
|
4397
|
+
BG-13 in XRechnung */
|
|
4398
|
+
deliveryInformation?: DeliveryInformation | undefined;
|
|
4399
|
+
/** BG-22
|
|
4400
|
+
Totals for the invoice */
|
|
4126
4401
|
totals?: InvoiceTotals | undefined;
|
|
4127
4402
|
/** Instructions how to perform the payment */
|
|
4128
4403
|
paymentInstructions?: PaymentInstructions | undefined;
|
|
4129
|
-
/**
|
|
4404
|
+
/** BG-24
|
|
4405
|
+
Attached documents to the invoice */
|
|
4130
4406
|
documents?: SupportingDocument[] | undefined;
|
|
4131
|
-
/**
|
|
4132
|
-
where parts are in different VAT categories */
|
|
4407
|
+
/** BG-23
|
|
4408
|
+
This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
|
|
4133
4409
|
vatBreakdown?: VatBreakdown[] | undefined;
|
|
4134
|
-
/**
|
|
4410
|
+
/** BG-20
|
|
4411
|
+
Allowances / deductions on the invoice */
|
|
4135
4412
|
allowances?: InvoiceAllowance[] | undefined;
|
|
4136
|
-
/**
|
|
4413
|
+
/** BG-21
|
|
4414
|
+
Charges / additional costs on the invoice */
|
|
4137
4415
|
charges?: InvoiceCharge[] | undefined;
|
|
4138
|
-
/**
|
|
4416
|
+
/** BG-25
|
|
4417
|
+
Single line items in the invoice */
|
|
4139
4418
|
lineItems?: InvoiceLineItem[] | undefined;
|
|
4140
4419
|
/** The source type from which the invoice was created */
|
|
4141
4420
|
sourceType: SourceType;
|
|
4421
|
+
/** In case the original invoice document was in Factur-X / ZUGFeRD format, this property can hold
|
|
4422
|
+
additional Factur-X specific data that is not part of the XRechnung specification */
|
|
4423
|
+
facturXData?: FacturXData | undefined;
|
|
4142
4424
|
constructor(data?: IInvoice);
|
|
4143
|
-
init(_data?: any): void;
|
|
4425
|
+
init?(_data?: any): void;
|
|
4144
4426
|
static fromJS(data: any): Invoice;
|
|
4145
|
-
toJSON(data?: any): any;
|
|
4427
|
+
toJSON?(data?: any): any;
|
|
4146
4428
|
}
|
|
4147
4429
|
/** This class represents an invoice */
|
|
4148
4430
|
export interface IInvoice {
|
|
4149
|
-
/**
|
|
4431
|
+
/** BT-1
|
|
4432
|
+
The number of the invoice */
|
|
4150
4433
|
invoiceNumber?: string | undefined;
|
|
4151
|
-
/**
|
|
4434
|
+
/** BT-2
|
|
4435
|
+
The date of the invoice */
|
|
4152
4436
|
invoiceDate?: Date | undefined;
|
|
4153
|
-
/**
|
|
4437
|
+
/** BT-3
|
|
4438
|
+
The type of the invoice */
|
|
4154
4439
|
invoiceType?: InvoiceType | undefined;
|
|
4155
|
-
/**
|
|
4440
|
+
/** BT-5
|
|
4441
|
+
The three letter ISO currency code */
|
|
4156
4442
|
currencyCode?: string | undefined;
|
|
4157
|
-
/**
|
|
4443
|
+
/** BT-9
|
|
4444
|
+
Until when the payment is due */
|
|
4158
4445
|
paymentDueDate?: Date | undefined;
|
|
4159
4446
|
/** An object holding reference used in this invoice */
|
|
4160
4447
|
references?: IReferences | undefined;
|
|
4161
|
-
/**
|
|
4448
|
+
/** BT-20
|
|
4449
|
+
A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4162
4450
|
paymentTerms?: string | undefined;
|
|
4163
|
-
/**
|
|
4451
|
+
/** If the PaymentTerms are present and in a correct format, this read-only property
|
|
4452
|
+
can be used to get the actual parsed payment terms in a deserialized and structured format. This will
|
|
4453
|
+
be null if PaymentTerms are not present or not in the correct format */
|
|
4454
|
+
parsedPaymentTerms?: IPaymentTerm[] | undefined;
|
|
4455
|
+
/** BG-3
|
|
4456
|
+
In case of partial or final invoices, it's possible to reference the previous invoice numbers */
|
|
4164
4457
|
previousInvoices?: IPreviousInvoice[] | undefined;
|
|
4165
|
-
/**
|
|
4458
|
+
/** BG-7
|
|
4459
|
+
Information about the buyer */
|
|
4166
4460
|
buyer?: IOrganization | undefined;
|
|
4167
|
-
/**
|
|
4461
|
+
/** BG-4
|
|
4462
|
+
Information about the seller */
|
|
4168
4463
|
seller?: IOrganization | undefined;
|
|
4169
|
-
/**
|
|
4464
|
+
/** BG-11
|
|
4465
|
+
Information about the sellers tax representative */
|
|
4466
|
+
sellerTaxRepresentative?: IOrganization | undefined;
|
|
4467
|
+
/** BG-10
|
|
4468
|
+
A payee is someone who receives the payment that is different from the seller */
|
|
4170
4469
|
payee?: IPayee | undefined;
|
|
4171
|
-
/**
|
|
4172
|
-
|
|
4470
|
+
/** BG-1
|
|
4471
|
+
If present, this is an unstructured text that can be used to give additional information
|
|
4472
|
+
about the invoice. Field BG-1 */
|
|
4173
4473
|
invoiceNotes?: IInvoiceNote[] | undefined;
|
|
4174
|
-
/**
|
|
4474
|
+
/** BG-14
|
|
4475
|
+
The period during which the services or goods were delivered */
|
|
4175
4476
|
invoicePeriod?: IInvoicePeriod | undefined;
|
|
4176
|
-
/**
|
|
4477
|
+
/** BG-13
|
|
4478
|
+
Information about the delivery
|
|
4479
|
+
BG-13 in XRechnung */
|
|
4480
|
+
deliveryInformation?: IDeliveryInformation | undefined;
|
|
4481
|
+
/** BG-22
|
|
4482
|
+
Totals for the invoice */
|
|
4177
4483
|
totals?: IInvoiceTotals | undefined;
|
|
4178
4484
|
/** Instructions how to perform the payment */
|
|
4179
4485
|
paymentInstructions?: IPaymentInstructions | undefined;
|
|
4180
|
-
/**
|
|
4486
|
+
/** BG-24
|
|
4487
|
+
Attached documents to the invoice */
|
|
4181
4488
|
documents?: ISupportingDocument[] | undefined;
|
|
4182
|
-
/**
|
|
4183
|
-
where parts are in different VAT categories */
|
|
4489
|
+
/** BG-23
|
|
4490
|
+
This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
|
|
4184
4491
|
vatBreakdown?: IVatBreakdown[] | undefined;
|
|
4185
|
-
/**
|
|
4492
|
+
/** BG-20
|
|
4493
|
+
Allowances / deductions on the invoice */
|
|
4186
4494
|
allowances?: IInvoiceAllowance[] | undefined;
|
|
4187
|
-
/**
|
|
4495
|
+
/** BG-21
|
|
4496
|
+
Charges / additional costs on the invoice */
|
|
4188
4497
|
charges?: IInvoiceCharge[] | undefined;
|
|
4189
|
-
/**
|
|
4498
|
+
/** BG-25
|
|
4499
|
+
Single line items in the invoice */
|
|
4190
4500
|
lineItems?: IInvoiceLineItem[] | undefined;
|
|
4191
4501
|
/** The source type from which the invoice was created */
|
|
4192
4502
|
sourceType: SourceType;
|
|
4503
|
+
/** In case the original invoice document was in Factur-X / ZUGFeRD format, this property can hold
|
|
4504
|
+
additional Factur-X specific data that is not part of the XRechnung specification */
|
|
4505
|
+
facturXData?: IFacturXData | undefined;
|
|
4193
4506
|
}
|
|
4194
4507
|
/** Type of the invoice */
|
|
4195
4508
|
export declare enum InvoiceType {
|
|
@@ -4204,319 +4517,1167 @@ export declare enum InvoiceType {
|
|
|
4204
4517
|
}
|
|
4205
4518
|
/** This class holds typical references used in an invoice */
|
|
4206
4519
|
export declare class References implements IReferences {
|
|
4207
|
-
/**
|
|
4520
|
+
/** BT-10
|
|
4521
|
+
An internal reference used by the buyer, this can also be used as the
|
|
4522
|
+
'Leitweg-ID' in Germany
|
|
4523
|
+
BT-10 in XRechnung. */
|
|
4208
4524
|
buyerReference?: string | undefined;
|
|
4209
|
-
/**
|
|
4525
|
+
/** BT-11
|
|
4526
|
+
Reference to a project
|
|
4527
|
+
BT-11 in XRechnung. */
|
|
4210
4528
|
projectReference?: string | undefined;
|
|
4211
|
-
/**
|
|
4529
|
+
/** BT-12
|
|
4530
|
+
Reference to a contract
|
|
4531
|
+
BT-12 in XRechnung. */
|
|
4212
4532
|
contractReference?: string | undefined;
|
|
4213
|
-
/**
|
|
4533
|
+
/** BT-13
|
|
4534
|
+
Reference to a purchase order created by the buyer
|
|
4535
|
+
BT-13 in XRechnung. */
|
|
4214
4536
|
purchaseOrderReference?: string | undefined;
|
|
4215
|
-
/**
|
|
4537
|
+
/** BT-14
|
|
4538
|
+
Reference to a sales order created by the seller
|
|
4539
|
+
BT-14 in XRechnung. */
|
|
4216
4540
|
salesOrderReference?: string | undefined;
|
|
4217
|
-
/**
|
|
4541
|
+
/** BT-15
|
|
4542
|
+
Reference to a delivery note
|
|
4543
|
+
BT-15 in XRechnung. */
|
|
4218
4544
|
receivingAdviceReference?: string | undefined;
|
|
4219
|
-
/**
|
|
4545
|
+
/** BT-16
|
|
4546
|
+
Reference to a dispatch advice
|
|
4547
|
+
BT-16 in XRechnung. */
|
|
4220
4548
|
dispatchAdviceReference?: string | undefined;
|
|
4221
|
-
/**
|
|
4549
|
+
/** BT-17
|
|
4550
|
+
Reference to a tender or lot
|
|
4551
|
+
BT-17 in XRechnung. */
|
|
4222
4552
|
tenderOrLotReference?: string | undefined;
|
|
4223
|
-
/**
|
|
4224
|
-
|
|
4553
|
+
/** BT-18
|
|
4554
|
+
Reference to a custom item, e.g. a phone number, person,
|
|
4555
|
+
contract or anything that would identify the invoice in the buyer's system
|
|
4556
|
+
BT-18 in XRechnung. */
|
|
4225
4557
|
invoicedObjectIdentifier?: string | undefined;
|
|
4558
|
+
/** BT-19
|
|
4559
|
+
This is a reference for accounting, like a cost center or similar. In German,
|
|
4560
|
+
this would be a "Kostenstelle".
|
|
4561
|
+
BT-19 in XRechnung. */
|
|
4562
|
+
accountingReference?: string | undefined;
|
|
4226
4563
|
constructor(data?: IReferences);
|
|
4227
|
-
init(_data?: any): void;
|
|
4564
|
+
init?(_data?: any): void;
|
|
4228
4565
|
static fromJS(data: any): References;
|
|
4229
|
-
toJSON(data?: any): any;
|
|
4566
|
+
toJSON?(data?: any): any;
|
|
4230
4567
|
}
|
|
4231
4568
|
/** This class holds typical references used in an invoice */
|
|
4232
4569
|
export interface IReferences {
|
|
4233
|
-
/**
|
|
4570
|
+
/** BT-10
|
|
4571
|
+
An internal reference used by the buyer, this can also be used as the
|
|
4572
|
+
'Leitweg-ID' in Germany
|
|
4573
|
+
BT-10 in XRechnung. */
|
|
4234
4574
|
buyerReference?: string | undefined;
|
|
4235
|
-
/**
|
|
4575
|
+
/** BT-11
|
|
4576
|
+
Reference to a project
|
|
4577
|
+
BT-11 in XRechnung. */
|
|
4236
4578
|
projectReference?: string | undefined;
|
|
4237
|
-
/**
|
|
4579
|
+
/** BT-12
|
|
4580
|
+
Reference to a contract
|
|
4581
|
+
BT-12 in XRechnung. */
|
|
4238
4582
|
contractReference?: string | undefined;
|
|
4239
|
-
/**
|
|
4583
|
+
/** BT-13
|
|
4584
|
+
Reference to a purchase order created by the buyer
|
|
4585
|
+
BT-13 in XRechnung. */
|
|
4240
4586
|
purchaseOrderReference?: string | undefined;
|
|
4241
|
-
/**
|
|
4587
|
+
/** BT-14
|
|
4588
|
+
Reference to a sales order created by the seller
|
|
4589
|
+
BT-14 in XRechnung. */
|
|
4242
4590
|
salesOrderReference?: string | undefined;
|
|
4243
|
-
/**
|
|
4591
|
+
/** BT-15
|
|
4592
|
+
Reference to a delivery note
|
|
4593
|
+
BT-15 in XRechnung. */
|
|
4244
4594
|
receivingAdviceReference?: string | undefined;
|
|
4245
|
-
/**
|
|
4595
|
+
/** BT-16
|
|
4596
|
+
Reference to a dispatch advice
|
|
4597
|
+
BT-16 in XRechnung. */
|
|
4246
4598
|
dispatchAdviceReference?: string | undefined;
|
|
4247
|
-
/**
|
|
4599
|
+
/** BT-17
|
|
4600
|
+
Reference to a tender or lot
|
|
4601
|
+
BT-17 in XRechnung. */
|
|
4248
4602
|
tenderOrLotReference?: string | undefined;
|
|
4249
|
-
/**
|
|
4250
|
-
|
|
4603
|
+
/** BT-18
|
|
4604
|
+
Reference to a custom item, e.g. a phone number, person,
|
|
4605
|
+
contract or anything that would identify the invoice in the buyer's system
|
|
4606
|
+
BT-18 in XRechnung. */
|
|
4251
4607
|
invoicedObjectIdentifier?: string | undefined;
|
|
4608
|
+
/** BT-19
|
|
4609
|
+
This is a reference for accounting, like a cost center or similar. In German,
|
|
4610
|
+
this would be a "Kostenstelle".
|
|
4611
|
+
BT-19 in XRechnung. */
|
|
4612
|
+
accountingReference?: string | undefined;
|
|
4613
|
+
}
|
|
4614
|
+
/** Represents a discount with a number of days, percentage, and an optional base amount. */
|
|
4615
|
+
export declare class PaymentTerm implements IPaymentTerm {
|
|
4616
|
+
/** The number of days until the discount is valid. */
|
|
4617
|
+
days: number;
|
|
4618
|
+
/** The percentage of the discount. */
|
|
4619
|
+
percent: number;
|
|
4620
|
+
/** The base amount for the discount, if applicable. */
|
|
4621
|
+
baseAmount?: number | undefined;
|
|
4622
|
+
constructor(data?: IPaymentTerm);
|
|
4623
|
+
init?(_data?: any): void;
|
|
4624
|
+
static fromJS(data: any): PaymentTerm;
|
|
4625
|
+
toJSON?(data?: any): any;
|
|
4626
|
+
}
|
|
4627
|
+
/** Represents a discount with a number of days, percentage, and an optional base amount. */
|
|
4628
|
+
export interface IPaymentTerm {
|
|
4629
|
+
/** The number of days until the discount is valid. */
|
|
4630
|
+
days: number;
|
|
4631
|
+
/** The percentage of the discount. */
|
|
4632
|
+
percent: number;
|
|
4633
|
+
/** The base amount for the discount, if applicable. */
|
|
4634
|
+
baseAmount?: number | undefined;
|
|
4252
4635
|
}
|
|
4253
4636
|
/** References to previous invoices */
|
|
4254
4637
|
export declare class PreviousInvoice implements IPreviousInvoice {
|
|
4255
|
-
/**
|
|
4638
|
+
/** BT-26
|
|
4639
|
+
The date of the previous invoice */
|
|
4256
4640
|
invoiceDate?: Date | undefined;
|
|
4257
|
-
/**
|
|
4641
|
+
/** BT-25
|
|
4642
|
+
The number of the previous invoice */
|
|
4258
4643
|
invoiceNumber: string;
|
|
4259
4644
|
constructor(data?: IPreviousInvoice);
|
|
4260
|
-
init(_data?: any): void;
|
|
4645
|
+
init?(_data?: any): void;
|
|
4261
4646
|
static fromJS(data: any): PreviousInvoice;
|
|
4262
|
-
toJSON(data?: any): any;
|
|
4647
|
+
toJSON?(data?: any): any;
|
|
4263
4648
|
}
|
|
4264
4649
|
/** References to previous invoices */
|
|
4265
4650
|
export interface IPreviousInvoice {
|
|
4266
|
-
/**
|
|
4651
|
+
/** BT-26
|
|
4652
|
+
The date of the previous invoice */
|
|
4267
4653
|
invoiceDate?: Date | undefined;
|
|
4268
|
-
/**
|
|
4654
|
+
/** BT-25
|
|
4655
|
+
The number of the previous invoice */
|
|
4269
4656
|
invoiceNumber: string;
|
|
4270
4657
|
}
|
|
4271
4658
|
/** Represents an organization, e.g. a buyer or a seller */
|
|
4272
4659
|
export declare class Organization implements IOrganization {
|
|
4273
|
-
/**
|
|
4660
|
+
/** BT-46 (BT-29 for the Seller)
|
|
4661
|
+
The identifier of the organization */
|
|
4662
|
+
identifier?: string | undefined;
|
|
4663
|
+
/** BT-46 (BT-29 for the Seller)
|
|
4664
|
+
If a Identifier is used, this indicates the scheme used for the identifier. This works
|
|
4665
|
+
in conjunction with the Identifier property. */
|
|
4666
|
+
identifierScheme?: string | undefined;
|
|
4667
|
+
/** BT-44 (BT-27 for the seller, BT-62 for the seller tax representative)
|
|
4668
|
+
The name of the organization */
|
|
4274
4669
|
name?: string | undefined;
|
|
4275
|
-
/**
|
|
4670
|
+
/** BT-30, for the seller, doesn't exist in the buyer actually
|
|
4671
|
+
A registration number, e.g. a Handelsregisternummer in Germany */
|
|
4672
|
+
registrationNumber?: string | undefined;
|
|
4673
|
+
/** BT-48, BT-32 for the seller, BT-63 for the seller tax representative
|
|
4674
|
+
The VAT ID for the organization */
|
|
4276
4675
|
vatId?: string | undefined;
|
|
4277
|
-
/**
|
|
4676
|
+
/** BT-32 for the seller, does not exist for the buyer
|
|
4677
|
+
The tax ID for the organization */
|
|
4678
|
+
taxId?: string | undefined;
|
|
4679
|
+
/** BT-49
|
|
4680
|
+
An email address for the organization */
|
|
4278
4681
|
email?: string | undefined;
|
|
4279
|
-
/**
|
|
4682
|
+
/** BT-56
|
|
4683
|
+
The name of a contact person */
|
|
4280
4684
|
contactPersonName?: string | undefined;
|
|
4281
|
-
/**
|
|
4685
|
+
/** BT-57
|
|
4686
|
+
The phone of a contact person */
|
|
4282
4687
|
contactPersonPhone?: string | undefined;
|
|
4283
|
-
/**
|
|
4688
|
+
/** BT-58
|
|
4689
|
+
The email of a contact person */
|
|
4284
4690
|
contactPersonEmail?: string | undefined;
|
|
4285
|
-
/**
|
|
4691
|
+
/** BT-50, BT-35 for the seller, BT-64 for the seller tax representative
|
|
4692
|
+
BT-51, BT-36 for the seller, BT-65 for the seller tax representative
|
|
4693
|
+
BT-163, BT-162 for the seller, BT-164 for the seller tax representative
|
|
4694
|
+
The address of the organization */
|
|
4286
4695
|
address?: string | undefined;
|
|
4287
|
-
/**
|
|
4696
|
+
/** BT-52, BT-37 for the seller, BT-66 for the seller tax representative
|
|
4697
|
+
The city of the organization */
|
|
4288
4698
|
city?: string | undefined;
|
|
4289
|
-
/**
|
|
4699
|
+
/** BT-53, BT-38 for the seller, BT-67 for the seller tax representative
|
|
4700
|
+
The zip code of the organization */
|
|
4290
4701
|
zipCode?: string | undefined;
|
|
4291
|
-
/**
|
|
4702
|
+
/** BT-55, BT-40 for the seller, BT-69 for the seller tax representative
|
|
4703
|
+
The ISO 3166-1 2 letter country code */
|
|
4292
4704
|
countryCode?: string | undefined;
|
|
4293
|
-
/**
|
|
4705
|
+
/** BT-54, BT-39 for the seller, BT-68 for the seller tax representative
|
|
4706
|
+
The state of the organization, e.g. a federal state in Germany */
|
|
4294
4707
|
state?: string | undefined;
|
|
4708
|
+
/** BT-33
|
|
4709
|
+
This provides some additional legal information.
|
|
4710
|
+
BT-33 in XRechnung, and this is only used for the seller. */
|
|
4711
|
+
additionalLegalInformation?: string | undefined;
|
|
4295
4712
|
constructor(data?: IOrganization);
|
|
4296
|
-
init(_data?: any): void;
|
|
4713
|
+
init?(_data?: any): void;
|
|
4297
4714
|
static fromJS(data: any): Organization;
|
|
4298
|
-
toJSON(data?: any): any;
|
|
4715
|
+
toJSON?(data?: any): any;
|
|
4299
4716
|
}
|
|
4300
4717
|
/** Represents an organization, e.g. a buyer or a seller */
|
|
4301
4718
|
export interface IOrganization {
|
|
4302
|
-
/**
|
|
4719
|
+
/** BT-46 (BT-29 for the Seller)
|
|
4720
|
+
The identifier of the organization */
|
|
4721
|
+
identifier?: string | undefined;
|
|
4722
|
+
/** BT-46 (BT-29 for the Seller)
|
|
4723
|
+
If a Identifier is used, this indicates the scheme used for the identifier. This works
|
|
4724
|
+
in conjunction with the Identifier property. */
|
|
4725
|
+
identifierScheme?: string | undefined;
|
|
4726
|
+
/** BT-44 (BT-27 for the seller, BT-62 for the seller tax representative)
|
|
4727
|
+
The name of the organization */
|
|
4303
4728
|
name?: string | undefined;
|
|
4304
|
-
/**
|
|
4729
|
+
/** BT-30, for the seller, doesn't exist in the buyer actually
|
|
4730
|
+
A registration number, e.g. a Handelsregisternummer in Germany */
|
|
4731
|
+
registrationNumber?: string | undefined;
|
|
4732
|
+
/** BT-48, BT-32 for the seller, BT-63 for the seller tax representative
|
|
4733
|
+
The VAT ID for the organization */
|
|
4305
4734
|
vatId?: string | undefined;
|
|
4306
|
-
/**
|
|
4735
|
+
/** BT-32 for the seller, does not exist for the buyer
|
|
4736
|
+
The tax ID for the organization */
|
|
4737
|
+
taxId?: string | undefined;
|
|
4738
|
+
/** BT-49
|
|
4739
|
+
An email address for the organization */
|
|
4307
4740
|
email?: string | undefined;
|
|
4308
|
-
/**
|
|
4741
|
+
/** BT-56
|
|
4742
|
+
The name of a contact person */
|
|
4309
4743
|
contactPersonName?: string | undefined;
|
|
4310
|
-
/**
|
|
4744
|
+
/** BT-57
|
|
4745
|
+
The phone of a contact person */
|
|
4311
4746
|
contactPersonPhone?: string | undefined;
|
|
4312
|
-
/**
|
|
4747
|
+
/** BT-58
|
|
4748
|
+
The email of a contact person */
|
|
4313
4749
|
contactPersonEmail?: string | undefined;
|
|
4314
|
-
/**
|
|
4750
|
+
/** BT-50, BT-35 for the seller, BT-64 for the seller tax representative
|
|
4751
|
+
BT-51, BT-36 for the seller, BT-65 for the seller tax representative
|
|
4752
|
+
BT-163, BT-162 for the seller, BT-164 for the seller tax representative
|
|
4753
|
+
The address of the organization */
|
|
4315
4754
|
address?: string | undefined;
|
|
4316
|
-
/**
|
|
4755
|
+
/** BT-52, BT-37 for the seller, BT-66 for the seller tax representative
|
|
4756
|
+
The city of the organization */
|
|
4317
4757
|
city?: string | undefined;
|
|
4318
|
-
/**
|
|
4758
|
+
/** BT-53, BT-38 for the seller, BT-67 for the seller tax representative
|
|
4759
|
+
The zip code of the organization */
|
|
4319
4760
|
zipCode?: string | undefined;
|
|
4320
|
-
/**
|
|
4761
|
+
/** BT-55, BT-40 for the seller, BT-69 for the seller tax representative
|
|
4762
|
+
The ISO 3166-1 2 letter country code */
|
|
4321
4763
|
countryCode?: string | undefined;
|
|
4322
|
-
/**
|
|
4764
|
+
/** BT-54, BT-39 for the seller, BT-68 for the seller tax representative
|
|
4765
|
+
The state of the organization, e.g. a federal state in Germany */
|
|
4323
4766
|
state?: string | undefined;
|
|
4767
|
+
/** BT-33
|
|
4768
|
+
This provides some additional legal information.
|
|
4769
|
+
BT-33 in XRechnung, and this is only used for the seller. */
|
|
4770
|
+
additionalLegalInformation?: string | undefined;
|
|
4324
4771
|
}
|
|
4325
4772
|
/** Represents a payee, meaning someone that receives the payment */
|
|
4326
4773
|
export declare class Payee implements IPayee {
|
|
4327
|
-
/**
|
|
4774
|
+
/** BT-59
|
|
4775
|
+
The name of the payee */
|
|
4328
4776
|
name?: string | undefined;
|
|
4329
|
-
/**
|
|
4777
|
+
/** BT-60
|
|
4778
|
+
The identifier of the payee */
|
|
4330
4779
|
identifier?: string | undefined;
|
|
4331
|
-
/**
|
|
4780
|
+
/** BT-61
|
|
4781
|
+
A registered identifier for the payee, e.g. a VAT ID
|
|
4332
4782
|
or Tax ID */
|
|
4333
4783
|
legalRegistrationIdentifier?: string | undefined;
|
|
4334
4784
|
constructor(data?: IPayee);
|
|
4335
|
-
init(_data?: any): void;
|
|
4785
|
+
init?(_data?: any): void;
|
|
4336
4786
|
static fromJS(data: any): Payee;
|
|
4337
|
-
toJSON(data?: any): any;
|
|
4787
|
+
toJSON?(data?: any): any;
|
|
4338
4788
|
}
|
|
4339
4789
|
/** Represents a payee, meaning someone that receives the payment */
|
|
4340
4790
|
export interface IPayee {
|
|
4341
|
-
/**
|
|
4791
|
+
/** BT-59
|
|
4792
|
+
The name of the payee */
|
|
4342
4793
|
name?: string | undefined;
|
|
4343
|
-
/**
|
|
4794
|
+
/** BT-60
|
|
4795
|
+
The identifier of the payee */
|
|
4344
4796
|
identifier?: string | undefined;
|
|
4345
|
-
/**
|
|
4797
|
+
/** BT-61
|
|
4798
|
+
A registered identifier for the payee, e.g. a VAT ID
|
|
4346
4799
|
or Tax ID */
|
|
4347
4800
|
legalRegistrationIdentifier?: string | undefined;
|
|
4348
4801
|
}
|
|
4349
4802
|
/** Represents a note / text in an invoice */
|
|
4350
4803
|
export declare class InvoiceNote implements IInvoiceNote {
|
|
4351
|
-
/**
|
|
4804
|
+
/** BT-21
|
|
4805
|
+
Short summary / heading. Should be a text code from this list:
|
|
4806
|
+
https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4451.htm
|
|
4807
|
+
Field BT-21 */
|
|
4352
4808
|
shortText?: string | undefined;
|
|
4353
|
-
/**
|
|
4809
|
+
/** Short summary / heading type. This will be automatically parsed from ShortText
|
|
4810
|
+
and is a read-only property. */
|
|
4811
|
+
shortTextType?: ShortTextType | undefined;
|
|
4812
|
+
/** BT-22
|
|
4813
|
+
Explanation of this note
|
|
4814
|
+
Field BT-22 */
|
|
4354
4815
|
longText?: string | undefined;
|
|
4355
4816
|
constructor(data?: IInvoiceNote);
|
|
4356
|
-
init(_data?: any): void;
|
|
4817
|
+
init?(_data?: any): void;
|
|
4357
4818
|
static fromJS(data: any): InvoiceNote;
|
|
4358
|
-
toJSON(data?: any): any;
|
|
4819
|
+
toJSON?(data?: any): any;
|
|
4359
4820
|
}
|
|
4360
4821
|
/** Represents a note / text in an invoice */
|
|
4361
4822
|
export interface IInvoiceNote {
|
|
4362
|
-
/**
|
|
4823
|
+
/** BT-21
|
|
4824
|
+
Short summary / heading. Should be a text code from this list:
|
|
4825
|
+
https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4451.htm
|
|
4826
|
+
Field BT-21 */
|
|
4363
4827
|
shortText?: string | undefined;
|
|
4364
|
-
/**
|
|
4828
|
+
/** Short summary / heading type. This will be automatically parsed from ShortText
|
|
4829
|
+
and is a read-only property. */
|
|
4830
|
+
shortTextType?: ShortTextType | undefined;
|
|
4831
|
+
/** BT-22
|
|
4832
|
+
Explanation of this note
|
|
4833
|
+
Field BT-22 */
|
|
4365
4834
|
longText?: string | undefined;
|
|
4366
4835
|
}
|
|
4836
|
+
/** Type qualifying the subject of the text. */
|
|
4837
|
+
export declare enum ShortTextType {
|
|
4838
|
+
GoodsItemDescription = "GoodsItemDescription",
|
|
4839
|
+
PaymentTerm = "PaymentTerm",
|
|
4840
|
+
DangerousGoodsAdditionalInformation = "DangerousGoodsAdditionalInformation",
|
|
4841
|
+
DangerousGoodsTechnicalName = "DangerousGoodsTechnicalName",
|
|
4842
|
+
AcknowledgementDescription = "AcknowledgementDescription",
|
|
4843
|
+
RateAdditionalInformation = "RateAdditionalInformation",
|
|
4844
|
+
PartyInstructions = "PartyInstructions",
|
|
4845
|
+
GeneralInformation = "GeneralInformation",
|
|
4846
|
+
AdditionalConditionsOfSalePurchase = "AdditionalConditionsOfSalePurchase",
|
|
4847
|
+
PriceConditions = "PriceConditions",
|
|
4848
|
+
GoodsDimensionsInCharacters = "GoodsDimensionsInCharacters",
|
|
4849
|
+
EquipmentReUsageRestrictions = "EquipmentReUsageRestrictions",
|
|
4850
|
+
HandlingRestriction = "HandlingRestriction",
|
|
4851
|
+
ErrorDescriptionFreeText = "ErrorDescriptionFreeText",
|
|
4852
|
+
ResponseFreeText = "ResponseFreeText",
|
|
4853
|
+
PackageContentsDescription = "PackageContentsDescription",
|
|
4854
|
+
TermsOfDelivery = "TermsOfDelivery",
|
|
4855
|
+
BillOfLadingRemarks = "BillOfLadingRemarks",
|
|
4856
|
+
ModeOfSettlementInformation = "ModeOfSettlementInformation",
|
|
4857
|
+
ConsignmentInvoiceInformation = "ConsignmentInvoiceInformation",
|
|
4858
|
+
ClearanceInvoiceInformation = "ClearanceInvoiceInformation",
|
|
4859
|
+
LetterOfCreditInformation = "LetterOfCreditInformation",
|
|
4860
|
+
LicenseInformation = "LicenseInformation",
|
|
4861
|
+
CertificationStatements = "CertificationStatements",
|
|
4862
|
+
AdditionalExportInformation = "AdditionalExportInformation",
|
|
4863
|
+
TariffStatements = "TariffStatements",
|
|
4864
|
+
MedicalHistory = "MedicalHistory",
|
|
4865
|
+
ConditionsOfSaleOrPurchase = "ConditionsOfSaleOrPurchase",
|
|
4866
|
+
ContractDocumentType = "ContractDocumentType",
|
|
4867
|
+
AdditionalTermsAndOrConditionsDocumentaryCredit = "AdditionalTermsAndOrConditionsDocumentaryCredit",
|
|
4868
|
+
InstructionsOrInformationAboutStandbyDocumentary = "InstructionsOrInformationAboutStandbyDocumentary",
|
|
4869
|
+
InstructionsOrInformationAboutPartialShipments = "InstructionsOrInformationAboutPartialShipments",
|
|
4870
|
+
InstructionsOrInformationAboutTranshipments = "InstructionsOrInformationAboutTranshipments",
|
|
4871
|
+
AdditionalHandlingInstructionsDocumentaryCredit = "AdditionalHandlingInstructionsDocumentaryCredit",
|
|
4872
|
+
DomesticRoutingInformation = "DomesticRoutingInformation",
|
|
4873
|
+
ChargeableCategoryOfEquipment = "ChargeableCategoryOfEquipment",
|
|
4874
|
+
GovernmentInformation = "GovernmentInformation",
|
|
4875
|
+
OnwardRoutingInformation = "OnwardRoutingInformation",
|
|
4876
|
+
AccountingInformation = "AccountingInformation",
|
|
4877
|
+
DiscrepancyInformation = "DiscrepancyInformation",
|
|
4878
|
+
ConfirmationInstructions = "ConfirmationInstructions",
|
|
4879
|
+
MethodOfIssuance = "MethodOfIssuance",
|
|
4880
|
+
DocumentsDeliveryInstructions = "DocumentsDeliveryInstructions",
|
|
4881
|
+
AdditionalConditions = "AdditionalConditions",
|
|
4882
|
+
InformationInstructionsAboutAdditionalAmountsCovered = "InformationInstructionsAboutAdditionalAmountsCovered",
|
|
4883
|
+
DeferredPaymentTermedAdditional = "DeferredPaymentTermedAdditional",
|
|
4884
|
+
AcceptanceTermsAdditional = "AcceptanceTermsAdditional",
|
|
4885
|
+
NegotiationTermsAdditional = "NegotiationTermsAdditional",
|
|
4886
|
+
DocumentNameAndDocumentaryRequirements = "DocumentNameAndDocumentaryRequirements",
|
|
4887
|
+
InstructionsInformationAboutRevolvingDocumentaryCredit = "InstructionsInformationAboutRevolvingDocumentaryCredit",
|
|
4888
|
+
DocumentaryRequirements = "DocumentaryRequirements",
|
|
4889
|
+
AdditionalInformation = "AdditionalInformation",
|
|
4890
|
+
FactorAssignmentClause = "FactorAssignmentClause",
|
|
4891
|
+
Reason = "Reason",
|
|
4892
|
+
Dispute = "Dispute",
|
|
4893
|
+
AdditionalAttributeInformation = "AdditionalAttributeInformation",
|
|
4894
|
+
AbsenceDeclaration = "AbsenceDeclaration",
|
|
4895
|
+
AggregationStatement = "AggregationStatement",
|
|
4896
|
+
CompilationStatement = "CompilationStatement",
|
|
4897
|
+
DefinitionalException = "DefinitionalException",
|
|
4898
|
+
PrivacyStatement = "PrivacyStatement",
|
|
4899
|
+
QualityStatement = "QualityStatement",
|
|
4900
|
+
StatisticalDescription = "StatisticalDescription",
|
|
4901
|
+
StatisticalDefinition = "StatisticalDefinition",
|
|
4902
|
+
StatisticalName = "StatisticalName",
|
|
4903
|
+
StatisticalTitle = "StatisticalTitle",
|
|
4904
|
+
OffDimensionInformation = "OffDimensionInformation",
|
|
4905
|
+
UnexpectedStopsInformation = "UnexpectedStopsInformation",
|
|
4906
|
+
Principles = "Principles",
|
|
4907
|
+
TermsAndDefinition = "TermsAndDefinition",
|
|
4908
|
+
SegmentName = "SegmentName",
|
|
4909
|
+
SimpleDataElementName = "SimpleDataElementName",
|
|
4910
|
+
Scope = "Scope",
|
|
4911
|
+
MessageTypeName = "MessageTypeName",
|
|
4912
|
+
Introduction = "Introduction",
|
|
4913
|
+
Glossary = "Glossary",
|
|
4914
|
+
FunctionalDefinition = "FunctionalDefinition",
|
|
4915
|
+
Examples = "Examples",
|
|
4916
|
+
CoverPage = "CoverPage",
|
|
4917
|
+
DependencySyntaxNotes = "DependencySyntaxNotes",
|
|
4918
|
+
CodeValueName = "CodeValueName",
|
|
4919
|
+
CodeListName = "CodeListName",
|
|
4920
|
+
ClarificationOfUsage = "ClarificationOfUsage",
|
|
4921
|
+
CompositeDataElementName = "CompositeDataElementName",
|
|
4922
|
+
FieldOfApplication = "FieldOfApplication",
|
|
4923
|
+
TypeOfAssetsAndLiabilities = "TypeOfAssetsAndLiabilities",
|
|
4924
|
+
PromotionInformation = "PromotionInformation",
|
|
4925
|
+
MeterCondition = "MeterCondition",
|
|
4926
|
+
MeterReadingInformation = "MeterReadingInformation",
|
|
4927
|
+
TypeOfTransactionReason = "TypeOfTransactionReason",
|
|
4928
|
+
TypeOfSurveyQuestion = "TypeOfSurveyQuestion",
|
|
4929
|
+
CarriersAgentCounterInformation = "CarriersAgentCounterInformation",
|
|
4930
|
+
DescriptionOfWorkItemOnEquipment = "DescriptionOfWorkItemOnEquipment",
|
|
4931
|
+
MessageDefinition = "MessageDefinition",
|
|
4932
|
+
BookedItemInformation = "BookedItemInformation",
|
|
4933
|
+
SourceOfDocument = "SourceOfDocument",
|
|
4934
|
+
Note = "Note",
|
|
4935
|
+
FixedPartOfSegmentClarificationText = "FixedPartOfSegmentClarificationText",
|
|
4936
|
+
CharacteristicsOfGoods = "CharacteristicsOfGoods",
|
|
4937
|
+
AdditionalDischargeInstructions = "AdditionalDischargeInstructions",
|
|
4938
|
+
ContainerStrippingInstructions = "ContainerStrippingInstructions",
|
|
4939
|
+
CscContainerSafetyConventionPlateInformation = "CscContainerSafetyConventionPlateInformation",
|
|
4940
|
+
CargoRemarks = "CargoRemarks",
|
|
4941
|
+
TemperatureControlInstructions = "TemperatureControlInstructions",
|
|
4942
|
+
TextRefersToExpectedData = "TextRefersToExpectedData",
|
|
4943
|
+
TextRefersToReceivedData = "TextRefersToReceivedData",
|
|
4944
|
+
SectionClarificationText = "SectionClarificationText",
|
|
4945
|
+
InformationToTheBeneficiary = "InformationToTheBeneficiary",
|
|
4946
|
+
InformationToTheApplicant = "InformationToTheApplicant",
|
|
4947
|
+
InstructionsToTheBeneficiary = "InstructionsToTheBeneficiary",
|
|
4948
|
+
InstructionsToTheApplicant = "InstructionsToTheApplicant",
|
|
4949
|
+
ControlledAtmosphere = "ControlledAtmosphere",
|
|
4950
|
+
TakeOffAnnotation = "TakeOffAnnotation",
|
|
4951
|
+
PriceVariationNarrative = "PriceVariationNarrative",
|
|
4952
|
+
DocumentaryCreditAmendmentInstructions = "DocumentaryCreditAmendmentInstructions",
|
|
4953
|
+
StandardMethodNarrative = "StandardMethodNarrative",
|
|
4954
|
+
ProjectNarrative = "ProjectNarrative",
|
|
4955
|
+
RadioactiveGoodsAdditionalInformation = "RadioactiveGoodsAdditionalInformation",
|
|
4956
|
+
BankToBankInformation = "BankToBankInformation",
|
|
4957
|
+
ReimbursementInstructions = "ReimbursementInstructions",
|
|
4958
|
+
ReasonForAmendingAMessage = "ReasonForAmendingAMessage",
|
|
4959
|
+
InstructionsToThePayingAndOrAcceptingAndOr = "InstructionsToThePayingAndOrAcceptingAndOr",
|
|
4960
|
+
InterestInstructions = "InterestInstructions",
|
|
4961
|
+
AgentCommission = "AgentCommission",
|
|
4962
|
+
RemittingBankInstructions = "RemittingBankInstructions",
|
|
4963
|
+
InstructionsToTheCollectingBank = "InstructionsToTheCollectingBank",
|
|
4964
|
+
CollectionAmountInstructions = "CollectionAmountInstructions",
|
|
4965
|
+
InternalAuditingInformation = "InternalAuditingInformation",
|
|
4966
|
+
Constraint = "Constraint",
|
|
4967
|
+
Comment = "Comment",
|
|
4968
|
+
SemanticNote = "SemanticNote",
|
|
4969
|
+
HelpText = "HelpText",
|
|
4970
|
+
Legend = "Legend",
|
|
4971
|
+
BatchCodeStructure = "BatchCodeStructure",
|
|
4972
|
+
ProductApplication = "ProductApplication",
|
|
4973
|
+
CustomerComplaint = "CustomerComplaint",
|
|
4974
|
+
ProbableCauseOfFault = "ProbableCauseOfFault",
|
|
4975
|
+
DefectDescription = "DefectDescription",
|
|
4976
|
+
RepairDescription = "RepairDescription",
|
|
4977
|
+
ReviewComments = "ReviewComments",
|
|
4978
|
+
Title = "Title",
|
|
4979
|
+
DescriptionOfAmount = "DescriptionOfAmount",
|
|
4980
|
+
Responsibilities = "Responsibilities",
|
|
4981
|
+
Supplier = "Supplier",
|
|
4982
|
+
PurchaseRegion = "PurchaseRegion",
|
|
4983
|
+
Affiliation = "Affiliation",
|
|
4984
|
+
Borrower = "Borrower",
|
|
4985
|
+
LineOfBusiness = "LineOfBusiness",
|
|
4986
|
+
FinancialInstitution = "FinancialInstitution",
|
|
4987
|
+
BusinessFounder = "BusinessFounder",
|
|
4988
|
+
BusinessHistory = "BusinessHistory",
|
|
4989
|
+
BankingArrangements = "BankingArrangements",
|
|
4990
|
+
BusinessOrigin = "BusinessOrigin",
|
|
4991
|
+
BrandNamesDescription = "BrandNamesDescription",
|
|
4992
|
+
BusinessFinancingDetails = "BusinessFinancingDetails",
|
|
4993
|
+
Competition = "Competition",
|
|
4994
|
+
ConstructionProcessDetails = "ConstructionProcessDetails",
|
|
4995
|
+
ConstructionSpecialty = "ConstructionSpecialty",
|
|
4996
|
+
ContractInformation = "ContractInformation",
|
|
4997
|
+
CorporateFiling = "CorporateFiling",
|
|
4998
|
+
CustomerInformation = "CustomerInformation",
|
|
4999
|
+
CopyrightNotice = "CopyrightNotice",
|
|
5000
|
+
ContingentDebt = "ContingentDebt",
|
|
5001
|
+
ConvictionDetails = "ConvictionDetails",
|
|
5002
|
+
Equipment = "Equipment",
|
|
5003
|
+
WorkforceDescription = "WorkforceDescription",
|
|
5004
|
+
Exemption = "Exemption",
|
|
5005
|
+
FuturePlans = "FuturePlans",
|
|
5006
|
+
IntervieweeConversationInformation = "IntervieweeConversationInformation",
|
|
5007
|
+
IntangibleAsset = "IntangibleAsset",
|
|
5008
|
+
Inventory = "Inventory",
|
|
5009
|
+
Investment = "Investment",
|
|
5010
|
+
IntercompanyRelationsInformation = "IntercompanyRelationsInformation",
|
|
5011
|
+
JointVenture = "JointVenture",
|
|
5012
|
+
Loan = "Loan",
|
|
5013
|
+
LongTermDebt = "LongTermDebt",
|
|
5014
|
+
Location = "Location",
|
|
5015
|
+
CurrentLegalStructure = "CurrentLegalStructure",
|
|
5016
|
+
MaritalContract = "MaritalContract",
|
|
5017
|
+
MarketingActivities = "MarketingActivities",
|
|
5018
|
+
Merger = "Merger",
|
|
5019
|
+
MarketableSecurities = "MarketableSecurities",
|
|
5020
|
+
BusinessDebt = "BusinessDebt",
|
|
5021
|
+
OriginalLegalStructure = "OriginalLegalStructure",
|
|
5022
|
+
EmployeeSharingArrangements = "EmployeeSharingArrangements",
|
|
5023
|
+
OrganizationDetails = "OrganizationDetails",
|
|
5024
|
+
PublicRecordDetails = "PublicRecordDetails",
|
|
5025
|
+
PriceRange = "PriceRange",
|
|
5026
|
+
Qualifications = "Qualifications",
|
|
5027
|
+
RegisteredActivity = "RegisteredActivity",
|
|
5028
|
+
CriminalSentence = "CriminalSentence",
|
|
5029
|
+
SalesMethod = "SalesMethod",
|
|
5030
|
+
EducationalInstitutionInformation = "EducationalInstitutionInformation",
|
|
5031
|
+
StatusDetails = "StatusDetails",
|
|
5032
|
+
Sales = "Sales",
|
|
5033
|
+
SpouseInformation = "SpouseInformation",
|
|
5034
|
+
EducationalDegreeInformation = "EducationalDegreeInformation",
|
|
5035
|
+
ShareholdingInformation = "ShareholdingInformation",
|
|
5036
|
+
SalesTerritory = "SalesTerritory",
|
|
5037
|
+
AccountantsComments = "AccountantsComments",
|
|
5038
|
+
ExemptionLawLocation = "ExemptionLawLocation",
|
|
5039
|
+
ShareClassifications = "ShareClassifications",
|
|
5040
|
+
Forecast = "Forecast",
|
|
5041
|
+
EventLocation = "EventLocation",
|
|
5042
|
+
FacilityOccupancy = "FacilityOccupancy",
|
|
5043
|
+
ImportAndExportDetails = "ImportAndExportDetails",
|
|
5044
|
+
AdditionalFacilityInformation = "AdditionalFacilityInformation",
|
|
5045
|
+
InventoryValue = "InventoryValue",
|
|
5046
|
+
Education = "Education",
|
|
5047
|
+
Event = "Event",
|
|
5048
|
+
Agent = "Agent",
|
|
5049
|
+
DomesticallyAgreedFinancialStatementDetails = "DomesticallyAgreedFinancialStatementDetails",
|
|
5050
|
+
OtherCurrentAssetDescription = "OtherCurrentAssetDescription",
|
|
5051
|
+
OtherCurrentLiabilityDescription = "OtherCurrentLiabilityDescription",
|
|
5052
|
+
FormerBusinessActivity = "FormerBusinessActivity",
|
|
5053
|
+
TradeNameUse = "TradeNameUse",
|
|
5054
|
+
SigningAuthority = "SigningAuthority",
|
|
5055
|
+
Guarantee = "Guarantee",
|
|
5056
|
+
HoldingCompanyOperation = "HoldingCompanyOperation",
|
|
5057
|
+
ConsignmentRouting = "ConsignmentRouting",
|
|
5058
|
+
LetterOfProtest = "LetterOfProtest",
|
|
5059
|
+
Question = "Question",
|
|
5060
|
+
PartyInformation = "PartyInformation",
|
|
5061
|
+
AreaBoundariesDescription = "AreaBoundariesDescription",
|
|
5062
|
+
AdvertisementInformation = "AdvertisementInformation",
|
|
5063
|
+
FinancialStatementDetails = "FinancialStatementDetails",
|
|
5064
|
+
AccessInstructions = "AccessInstructions",
|
|
5065
|
+
Liquidity = "Liquidity",
|
|
5066
|
+
CreditLine = "CreditLine",
|
|
5067
|
+
WarrantyTerms = "WarrantyTerms",
|
|
5068
|
+
DivisionDescription = "DivisionDescription",
|
|
5069
|
+
ReportingInstruction = "ReportingInstruction",
|
|
5070
|
+
ExaminationResult = "ExaminationResult",
|
|
5071
|
+
LaboratoryResult = "LaboratoryResult",
|
|
5072
|
+
AllowanceChargeInformation = "AllowanceChargeInformation",
|
|
5073
|
+
XRayResult = "XRayResult",
|
|
5074
|
+
PathologyResult = "PathologyResult",
|
|
5075
|
+
InterventionDescription = "InterventionDescription",
|
|
5076
|
+
SummaryOfAdmittance = "SummaryOfAdmittance",
|
|
5077
|
+
MedicalTreatmentCourseDetail = "MedicalTreatmentCourseDetail",
|
|
5078
|
+
Prognosis = "Prognosis",
|
|
5079
|
+
InstructionToPatient = "InstructionToPatient",
|
|
5080
|
+
InstructionToPhysician = "InstructionToPhysician",
|
|
5081
|
+
AllDocuments = "AllDocuments",
|
|
5082
|
+
MedicineTreatment = "MedicineTreatment",
|
|
5083
|
+
MedicineDosageAndAdministration = "MedicineDosageAndAdministration",
|
|
5084
|
+
AvailabilityOfPatient = "AvailabilityOfPatient",
|
|
5085
|
+
ReasonForServiceRequest = "ReasonForServiceRequest",
|
|
5086
|
+
PurposeOfService = "PurposeOfService",
|
|
5087
|
+
ArrivalConditions = "ArrivalConditions",
|
|
5088
|
+
ServiceRequestersComment = "ServiceRequestersComment",
|
|
5089
|
+
Authentication = "Authentication",
|
|
5090
|
+
RequestedLocationDescription = "RequestedLocationDescription",
|
|
5091
|
+
MedicineAdministrationCondition = "MedicineAdministrationCondition",
|
|
5092
|
+
PatientInformation = "PatientInformation",
|
|
5093
|
+
PrecautionaryMeasure = "PrecautionaryMeasure",
|
|
5094
|
+
ServiceCharacteristic = "ServiceCharacteristic",
|
|
5095
|
+
PlannedEventComment = "PlannedEventComment",
|
|
5096
|
+
ExpectedDelayComment = "ExpectedDelayComment",
|
|
5097
|
+
TransportRequirementsComment = "TransportRequirementsComment",
|
|
5098
|
+
TemporaryApprovalCondition = "TemporaryApprovalCondition",
|
|
5099
|
+
CustomsValuationInformation = "CustomsValuationInformation",
|
|
5100
|
+
ValueAddedTaxVatMarginScheme = "ValueAddedTaxVatMarginScheme",
|
|
5101
|
+
PassengerBaggageInformation = "PassengerBaggageInformation",
|
|
5102
|
+
AdditionalProductInformationAddress = "AdditionalProductInformationAddress",
|
|
5103
|
+
InformationToBePrintedOnDespatchAdvice = "InformationToBePrintedOnDespatchAdvice",
|
|
5104
|
+
MissingGoodsRemarks = "MissingGoodsRemarks",
|
|
5105
|
+
NonAcceptanceInformation = "NonAcceptanceInformation",
|
|
5106
|
+
ReturnsInformation = "ReturnsInformation",
|
|
5107
|
+
SubLineItemInformation = "SubLineItemInformation",
|
|
5108
|
+
TestInformation = "TestInformation",
|
|
5109
|
+
ExternalLink = "ExternalLink",
|
|
5110
|
+
VatExemptionReason = "VatExemptionReason",
|
|
5111
|
+
TransportContractDocumentClause = "TransportContractDocumentClause",
|
|
5112
|
+
InstructionToPrepareThePatient = "InstructionToPrepareThePatient",
|
|
5113
|
+
MedicineTreatmentComment = "MedicineTreatmentComment",
|
|
5114
|
+
ExaminationResultComment = "ExaminationResultComment",
|
|
5115
|
+
ServiceRequestComment = "ServiceRequestComment",
|
|
5116
|
+
PrescriptionReason = "PrescriptionReason",
|
|
5117
|
+
PrescriptionComment = "PrescriptionComment",
|
|
5118
|
+
ClinicalInvestigationComment = "ClinicalInvestigationComment",
|
|
5119
|
+
MedicinalSpecificationComment = "MedicinalSpecificationComment",
|
|
5120
|
+
EconomicContributionComment = "EconomicContributionComment",
|
|
5121
|
+
StatusOfAPlan = "StatusOfAPlan",
|
|
5122
|
+
RandomSampleTestInformation = "RandomSampleTestInformation",
|
|
5123
|
+
PeriodOfTime = "PeriodOfTime",
|
|
5124
|
+
Legislation = "Legislation",
|
|
5125
|
+
SecurityMeasuresRequested = "SecurityMeasuresRequested",
|
|
5126
|
+
TransportContractDocumentRemark = "TransportContractDocumentRemark",
|
|
5127
|
+
PreviousPortOfCallSecurityInformation = "PreviousPortOfCallSecurityInformation",
|
|
5128
|
+
SecurityInformation = "SecurityInformation",
|
|
5129
|
+
WasteInformation = "WasteInformation",
|
|
5130
|
+
B2cMarketingInformationShortDescription = "B2cMarketingInformationShortDescription",
|
|
5131
|
+
B2bMarketingInformationLongDescription = "B2bMarketingInformationLongDescription",
|
|
5132
|
+
B2cMarketingInformationLongDescription = "B2cMarketingInformationLongDescription",
|
|
5133
|
+
ProductIngredients = "ProductIngredients",
|
|
5134
|
+
LocationShortName = "LocationShortName",
|
|
5135
|
+
PackagingMaterialInformation = "PackagingMaterialInformation",
|
|
5136
|
+
FillerMaterialInformation = "FillerMaterialInformation",
|
|
5137
|
+
ShipToShipActivityInformation = "ShipToShipActivityInformation",
|
|
5138
|
+
PackageMaterialDescription = "PackageMaterialDescription",
|
|
5139
|
+
ConsumerLevelPackageMarking = "ConsumerLevelPackageMarking",
|
|
5140
|
+
CustomsClearanceInstructions = "CustomsClearanceInstructions",
|
|
5141
|
+
CustomsClearanceInstructionsExport = "CustomsClearanceInstructionsExport",
|
|
5142
|
+
ChangeInformation = "ChangeInformation",
|
|
5143
|
+
CustomsClearanceInstructionImport = "CustomsClearanceInstructionImport",
|
|
5144
|
+
ClearancePlaceRequested = "ClearancePlaceRequested",
|
|
5145
|
+
LoadingRemarks = "LoadingRemarks",
|
|
5146
|
+
OrderInformation = "OrderInformation",
|
|
5147
|
+
CustomerRemarks = "CustomerRemarks",
|
|
5148
|
+
CustomsDeclarationInformation = "CustomsDeclarationInformation",
|
|
5149
|
+
DamageRemarks = "DamageRemarks",
|
|
5150
|
+
DocumentIssuerDeclaration = "DocumentIssuerDeclaration",
|
|
5151
|
+
DeliveryInformation = "DeliveryInformation",
|
|
5152
|
+
DeliveryInstructions = "DeliveryInstructions",
|
|
5153
|
+
DocumentationInstructions = "DocumentationInstructions",
|
|
5154
|
+
DutyDeclaration = "DutyDeclaration",
|
|
5155
|
+
EffectiveUsedRouting = "EffectiveUsedRouting",
|
|
5156
|
+
FirstBlockToBePrintedOnTheTransportContract = "FirstBlockToBePrintedOnTheTransportContract",
|
|
5157
|
+
GovernmentBillOfLadingInformation = "GovernmentBillOfLadingInformation",
|
|
5158
|
+
EntireTransactionSet = "EntireTransactionSet",
|
|
5159
|
+
FurtherInformationConcerningGGVSPar7 = "FurtherInformationConcerningGGVSPar7",
|
|
5160
|
+
ConsignmentHandlingInstruction = "ConsignmentHandlingInstruction",
|
|
5161
|
+
HazardInformation = "HazardInformation",
|
|
5162
|
+
ConsignmentInformationForConsignee = "ConsignmentInformationForConsignee",
|
|
5163
|
+
InsuranceInstructions = "InsuranceInstructions",
|
|
5164
|
+
InvoiceMailingInstructions = "InvoiceMailingInstructions",
|
|
5165
|
+
CommercialInvoiceItemDescription = "CommercialInvoiceItemDescription",
|
|
5166
|
+
InsuranceInformation = "InsuranceInformation",
|
|
5167
|
+
InvoiceInstruction = "InvoiceInstruction",
|
|
5168
|
+
InformationForRailwayPurpose = "InformationForRailwayPurpose",
|
|
5169
|
+
InlandTransportDetails = "InlandTransportDetails",
|
|
5170
|
+
TestingInstructions = "TestingInstructions",
|
|
5171
|
+
LocationAlias = "LocationAlias",
|
|
5172
|
+
LineItem = "LineItem",
|
|
5173
|
+
LoadingInstruction = "LoadingInstruction",
|
|
5174
|
+
MiscellaneousChargeOrder = "MiscellaneousChargeOrder",
|
|
5175
|
+
MaritimeDeclarationOfHealth = "MaritimeDeclarationOfHealth",
|
|
5176
|
+
AdditionalMarksNumbersInformation = "AdditionalMarksNumbersInformation",
|
|
5177
|
+
OrderInstruction = "OrderInstruction",
|
|
5178
|
+
OtherServiceInformation = "OtherServiceInformation",
|
|
5179
|
+
PackingMarkingInformation = "PackingMarkingInformation",
|
|
5180
|
+
PaymentInstructionsInformation = "PaymentInstructionsInformation",
|
|
5181
|
+
PayablesInformation = "PayablesInformation",
|
|
5182
|
+
PackagingInformation = "PackagingInformation",
|
|
5183
|
+
PackagingTermsInformation = "PackagingTermsInformation",
|
|
5184
|
+
PaymentDetailRemittanceInformation = "PaymentDetailRemittanceInformation",
|
|
5185
|
+
PaymentInformation = "PaymentInformation",
|
|
5186
|
+
ProductInformation = "ProductInformation",
|
|
5187
|
+
PriceCalculationFormula = "PriceCalculationFormula",
|
|
5188
|
+
PriorityInformation = "PriorityInformation",
|
|
5189
|
+
PurchasingInformation = "PurchasingInformation",
|
|
5190
|
+
QuarantineInstructions = "QuarantineInstructions",
|
|
5191
|
+
QualityDemandsRequirements = "QualityDemandsRequirements",
|
|
5192
|
+
QuotationInstructionInformation = "QuotationInstructionInformation",
|
|
5193
|
+
RiskAndHandlingInformation = "RiskAndHandlingInformation",
|
|
5194
|
+
RegulatoryInformation = "RegulatoryInformation",
|
|
5195
|
+
ReturnToOriginInformation = "ReturnToOriginInformation",
|
|
5196
|
+
Receivables = "Receivables",
|
|
5197
|
+
ConsignmentRoute = "ConsignmentRoute",
|
|
5198
|
+
SafetyInformation = "SafetyInformation",
|
|
5199
|
+
ConsignmentDocumentaryInstruction = "ConsignmentDocumentaryInstruction",
|
|
5200
|
+
SpecialInstructions = "SpecialInstructions",
|
|
5201
|
+
ShipLineRequested = "ShipLineRequested",
|
|
5202
|
+
SpecialPermissionForTransportGenerally = "SpecialPermissionForTransportGenerally",
|
|
5203
|
+
SpecialPermissionConcerningTheGoodsToBeTransported = "SpecialPermissionConcerningTheGoodsToBeTransported",
|
|
5204
|
+
SpecialHandling = "SpecialHandling",
|
|
5205
|
+
SpecialPermissionConcerningPackage = "SpecialPermissionConcerningPackage",
|
|
5206
|
+
SpecialPermissionConcerningTransportMeans = "SpecialPermissionConcerningTransportMeans",
|
|
5207
|
+
SubsidiaryRiskNumberIataDgr = "SubsidiaryRiskNumberIataDgr",
|
|
5208
|
+
SpecialServiceRequest = "SpecialServiceRequest",
|
|
5209
|
+
SupplierRemarks = "SupplierRemarks",
|
|
5210
|
+
ConsignmentTariff = "ConsignmentTariff",
|
|
5211
|
+
ConsignmentTransport = "ConsignmentTransport",
|
|
5212
|
+
TransportationInformation = "TransportationInformation",
|
|
5213
|
+
RequestedTariff = "RequestedTariff",
|
|
5214
|
+
TaxDeclaration = "TaxDeclaration",
|
|
5215
|
+
WarehouseInstructionInformation = "WarehouseInstructionInformation",
|
|
5216
|
+
MutuallyDefined = "MutuallyDefined"
|
|
5217
|
+
}
|
|
4367
5218
|
/** Represents an invoice period with start and end dates */
|
|
4368
5219
|
export declare class InvoicePeriod implements IInvoicePeriod {
|
|
4369
|
-
/**
|
|
5220
|
+
/** BT-134
|
|
5221
|
+
The start date */
|
|
4370
5222
|
start?: Date | undefined;
|
|
4371
|
-
/**
|
|
5223
|
+
/** BT-135
|
|
5224
|
+
The end date */
|
|
4372
5225
|
end?: Date | undefined;
|
|
4373
5226
|
constructor(data?: IInvoicePeriod);
|
|
4374
|
-
init(_data?: any): void;
|
|
5227
|
+
init?(_data?: any): void;
|
|
4375
5228
|
static fromJS(data: any): InvoicePeriod;
|
|
4376
|
-
toJSON(data?: any): any;
|
|
5229
|
+
toJSON?(data?: any): any;
|
|
4377
5230
|
}
|
|
4378
5231
|
/** Represents an invoice period with start and end dates */
|
|
4379
5232
|
export interface IInvoicePeriod {
|
|
4380
|
-
/**
|
|
5233
|
+
/** BT-134
|
|
5234
|
+
The start date */
|
|
4381
5235
|
start?: Date | undefined;
|
|
4382
|
-
/**
|
|
5236
|
+
/** BT-135
|
|
5237
|
+
The end date */
|
|
4383
5238
|
end?: Date | undefined;
|
|
4384
5239
|
}
|
|
5240
|
+
/** Information about the delivery */
|
|
5241
|
+
export declare class DeliveryInformation implements IDeliveryInformation {
|
|
5242
|
+
/** BT-70
|
|
5243
|
+
BT-70 in XRechnung */
|
|
5244
|
+
deliverToName?: string | undefined;
|
|
5245
|
+
/** BT-71
|
|
5246
|
+
BT-71 in XRechnung */
|
|
5247
|
+
deliverToLocationIdentifier?: string | undefined;
|
|
5248
|
+
/** BT-72
|
|
5249
|
+
BT-72 in XRechnung */
|
|
5250
|
+
deliveryDate?: Date | undefined;
|
|
5251
|
+
/** BG-15
|
|
5252
|
+
BG-15 in XRechnung */
|
|
5253
|
+
deliveryAddress?: DeliveryAddress | undefined;
|
|
5254
|
+
constructor(data?: IDeliveryInformation);
|
|
5255
|
+
init?(_data?: any): void;
|
|
5256
|
+
static fromJS(data: any): DeliveryInformation;
|
|
5257
|
+
toJSON?(data?: any): any;
|
|
5258
|
+
}
|
|
5259
|
+
/** Information about the delivery */
|
|
5260
|
+
export interface IDeliveryInformation {
|
|
5261
|
+
/** BT-70
|
|
5262
|
+
BT-70 in XRechnung */
|
|
5263
|
+
deliverToName?: string | undefined;
|
|
5264
|
+
/** BT-71
|
|
5265
|
+
BT-71 in XRechnung */
|
|
5266
|
+
deliverToLocationIdentifier?: string | undefined;
|
|
5267
|
+
/** BT-72
|
|
5268
|
+
BT-72 in XRechnung */
|
|
5269
|
+
deliveryDate?: Date | undefined;
|
|
5270
|
+
/** BG-15
|
|
5271
|
+
BG-15 in XRechnung */
|
|
5272
|
+
deliveryAddress?: IDeliveryAddress | undefined;
|
|
5273
|
+
}
|
|
5274
|
+
/** Address for deliveries */
|
|
5275
|
+
export declare class DeliveryAddress implements IDeliveryAddress {
|
|
5276
|
+
/** BT-75, BT-76 and BT-165
|
|
5277
|
+
The address. BT-75, BT-76 and BT-165 in XRechnung. */
|
|
5278
|
+
address?: string | undefined;
|
|
5279
|
+
/** BT-77
|
|
5280
|
+
The city. BT-77 in XRechnung. */
|
|
5281
|
+
city?: string | undefined;
|
|
5282
|
+
/** BT-78
|
|
5283
|
+
The zip code. BT-78 in XRechnung. */
|
|
5284
|
+
zipCode?: string | undefined;
|
|
5285
|
+
/** BT-80
|
|
5286
|
+
The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
|
|
5287
|
+
countryCode?: string | undefined;
|
|
5288
|
+
constructor(data?: IDeliveryAddress);
|
|
5289
|
+
init?(_data?: any): void;
|
|
5290
|
+
static fromJS(data: any): DeliveryAddress;
|
|
5291
|
+
toJSON?(data?: any): any;
|
|
5292
|
+
}
|
|
5293
|
+
/** Address for deliveries */
|
|
5294
|
+
export interface IDeliveryAddress {
|
|
5295
|
+
/** BT-75, BT-76 and BT-165
|
|
5296
|
+
The address. BT-75, BT-76 and BT-165 in XRechnung. */
|
|
5297
|
+
address?: string | undefined;
|
|
5298
|
+
/** BT-77
|
|
5299
|
+
The city. BT-77 in XRechnung. */
|
|
5300
|
+
city?: string | undefined;
|
|
5301
|
+
/** BT-78
|
|
5302
|
+
The zip code. BT-78 in XRechnung. */
|
|
5303
|
+
zipCode?: string | undefined;
|
|
5304
|
+
/** BT-80
|
|
5305
|
+
The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
|
|
5306
|
+
countryCode?: string | undefined;
|
|
5307
|
+
}
|
|
4385
5308
|
/** Totals for the invoice */
|
|
4386
5309
|
export declare class InvoiceTotals implements IInvoiceTotals {
|
|
4387
|
-
/**
|
|
5310
|
+
/** BT-106
|
|
5311
|
+
Sum of all invoice items in net.
|
|
5312
|
+
BT-106 in XRechnung. */
|
|
4388
5313
|
totalNet?: number | undefined;
|
|
4389
|
-
/**
|
|
5314
|
+
/** BT-107
|
|
5315
|
+
This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
|
|
5316
|
+
BT-107 in XRechnung. */
|
|
4390
5317
|
totalAllowances?: number | undefined;
|
|
4391
|
-
/**
|
|
4392
|
-
|
|
5318
|
+
/** BT-108
|
|
5319
|
+
This is the sum of all charges in the invoice, except VAT. For example, late
|
|
5320
|
+
fees or surcharges.
|
|
5321
|
+
BT-108 in XRechnung. */
|
|
4393
5322
|
totalCharges?: number | undefined;
|
|
4394
|
-
/**
|
|
4395
|
-
|
|
5323
|
+
/** BT-109
|
|
5324
|
+
This is the total net value of the invoice after applied allowances and charges,
|
|
5325
|
+
meaning the actual net sum to be paid.
|
|
5326
|
+
BT-109 in XRechnung. */
|
|
4396
5327
|
totalAfterDeductions?: number | undefined;
|
|
4397
|
-
/**
|
|
5328
|
+
/** BT-110
|
|
5329
|
+
The total amount of VAT in the invoice.
|
|
5330
|
+
BT-110 in XRechnung. */
|
|
4398
5331
|
totalVatAmount?: number | undefined;
|
|
4399
|
-
/**
|
|
5332
|
+
/** BT-112
|
|
5333
|
+
The total gross amount of the invoice, including all taxes and deductions.
|
|
5334
|
+
BT-112 in XRechnung. */
|
|
4400
5335
|
totalGross?: number | undefined;
|
|
4401
|
-
/**
|
|
4402
|
-
|
|
5336
|
+
/** BT-113
|
|
5337
|
+
The total amount that has already been paid for this invoice, e.g. used when
|
|
5338
|
+
previous invoice sums are included here that have already been paid.
|
|
5339
|
+
BT-113 in XRechnung. */
|
|
4403
5340
|
alreadyPaidTotal?: number | undefined;
|
|
4404
|
-
/**
|
|
4405
|
-
|
|
5341
|
+
/** BT-114
|
|
5342
|
+
If this is given, this specifies if any rounding amount is applied to the invoice,
|
|
5343
|
+
before calculating the TotalToBePaid value.
|
|
5344
|
+
BT-114 in XRechnung. */
|
|
5345
|
+
payableRoundingAmount?: number | undefined;
|
|
5346
|
+
/** BT-115
|
|
5347
|
+
The sum that needs to be paid for this invoice. This is the total gross amount
|
|
5348
|
+
minus the already paid amount.
|
|
5349
|
+
BT-115 in XRechnung. */
|
|
4406
5350
|
totalToBePaid?: number | undefined;
|
|
4407
5351
|
constructor(data?: IInvoiceTotals);
|
|
4408
|
-
init(_data?: any): void;
|
|
5352
|
+
init?(_data?: any): void;
|
|
4409
5353
|
static fromJS(data: any): InvoiceTotals;
|
|
4410
|
-
toJSON(data?: any): any;
|
|
5354
|
+
toJSON?(data?: any): any;
|
|
4411
5355
|
}
|
|
4412
5356
|
/** Totals for the invoice */
|
|
4413
5357
|
export interface IInvoiceTotals {
|
|
4414
|
-
/**
|
|
5358
|
+
/** BT-106
|
|
5359
|
+
Sum of all invoice items in net.
|
|
5360
|
+
BT-106 in XRechnung. */
|
|
4415
5361
|
totalNet?: number | undefined;
|
|
4416
|
-
/**
|
|
5362
|
+
/** BT-107
|
|
5363
|
+
This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
|
|
5364
|
+
BT-107 in XRechnung. */
|
|
4417
5365
|
totalAllowances?: number | undefined;
|
|
4418
|
-
/**
|
|
4419
|
-
|
|
5366
|
+
/** BT-108
|
|
5367
|
+
This is the sum of all charges in the invoice, except VAT. For example, late
|
|
5368
|
+
fees or surcharges.
|
|
5369
|
+
BT-108 in XRechnung. */
|
|
4420
5370
|
totalCharges?: number | undefined;
|
|
4421
|
-
/**
|
|
4422
|
-
|
|
5371
|
+
/** BT-109
|
|
5372
|
+
This is the total net value of the invoice after applied allowances and charges,
|
|
5373
|
+
meaning the actual net sum to be paid.
|
|
5374
|
+
BT-109 in XRechnung. */
|
|
4423
5375
|
totalAfterDeductions?: number | undefined;
|
|
4424
|
-
/**
|
|
5376
|
+
/** BT-110
|
|
5377
|
+
The total amount of VAT in the invoice.
|
|
5378
|
+
BT-110 in XRechnung. */
|
|
4425
5379
|
totalVatAmount?: number | undefined;
|
|
4426
|
-
/**
|
|
5380
|
+
/** BT-112
|
|
5381
|
+
The total gross amount of the invoice, including all taxes and deductions.
|
|
5382
|
+
BT-112 in XRechnung. */
|
|
4427
5383
|
totalGross?: number | undefined;
|
|
4428
|
-
/**
|
|
4429
|
-
|
|
5384
|
+
/** BT-113
|
|
5385
|
+
The total amount that has already been paid for this invoice, e.g. used when
|
|
5386
|
+
previous invoice sums are included here that have already been paid.
|
|
5387
|
+
BT-113 in XRechnung. */
|
|
4430
5388
|
alreadyPaidTotal?: number | undefined;
|
|
4431
|
-
/**
|
|
4432
|
-
|
|
5389
|
+
/** BT-114
|
|
5390
|
+
If this is given, this specifies if any rounding amount is applied to the invoice,
|
|
5391
|
+
before calculating the TotalToBePaid value.
|
|
5392
|
+
BT-114 in XRechnung. */
|
|
5393
|
+
payableRoundingAmount?: number | undefined;
|
|
5394
|
+
/** BT-115
|
|
5395
|
+
The sum that needs to be paid for this invoice. This is the total gross amount
|
|
5396
|
+
minus the already paid amount.
|
|
5397
|
+
BT-115 in XRechnung. */
|
|
4433
5398
|
totalToBePaid?: number | undefined;
|
|
4434
5399
|
}
|
|
4435
5400
|
/** Instructions how payment for an invoice should be provided. */
|
|
4436
5401
|
export declare class PaymentInstructions implements IPaymentInstructions {
|
|
4437
|
-
/**
|
|
5402
|
+
/** BT-82
|
|
5403
|
+
Additional text to describe the payment instructions. */
|
|
4438
5404
|
description?: string | undefined;
|
|
4439
|
-
/**
|
|
5405
|
+
/** BT-81
|
|
5406
|
+
This should be a code according to UNCL 4461
|
|
4440
5407
|
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
4441
|
-
and code "30" means non-SEPA Credit Transfer.
|
|
5408
|
+
and code "30" means non-SEPA Credit Transfer.
|
|
5409
|
+
See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
|
|
4442
5410
|
paymentTypeCode?: string | undefined;
|
|
4443
|
-
/**
|
|
5411
|
+
/** This should be a type according to UNCL 4461
|
|
5412
|
+
to identify the type of payment. */
|
|
5413
|
+
paymentType?: PaymentType | undefined;
|
|
5414
|
+
/** BT-90
|
|
5415
|
+
If a SEPA direct debit payment mean is used, then this reference should be provided.
|
|
5416
|
+
It's the creditor identifier in SEPA, in German "Gläubiger-Identifikationsnummer".
|
|
5417
|
+
Field BT-90 in XRechnung. */
|
|
5418
|
+
paymentCreditorIdentifier?: string | undefined;
|
|
5419
|
+
/** BG-16
|
|
5420
|
+
A list of payment means that can be used to pay the invoice. */
|
|
4444
5421
|
paymentMeans?: PaymentMeans[] | undefined;
|
|
4445
5422
|
constructor(data?: IPaymentInstructions);
|
|
4446
|
-
init(_data?: any): void;
|
|
5423
|
+
init?(_data?: any): void;
|
|
4447
5424
|
static fromJS(data: any): PaymentInstructions;
|
|
4448
|
-
toJSON(data?: any): any;
|
|
5425
|
+
toJSON?(data?: any): any;
|
|
4449
5426
|
}
|
|
4450
5427
|
/** Instructions how payment for an invoice should be provided. */
|
|
4451
5428
|
export interface IPaymentInstructions {
|
|
4452
|
-
/**
|
|
5429
|
+
/** BT-82
|
|
5430
|
+
Additional text to describe the payment instructions. */
|
|
4453
5431
|
description?: string | undefined;
|
|
4454
|
-
/**
|
|
5432
|
+
/** BT-81
|
|
5433
|
+
This should be a code according to UNCL 4461
|
|
4455
5434
|
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
4456
|
-
and code "30" means non-SEPA Credit Transfer.
|
|
5435
|
+
and code "30" means non-SEPA Credit Transfer.
|
|
5436
|
+
See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
|
|
4457
5437
|
paymentTypeCode?: string | undefined;
|
|
4458
|
-
/**
|
|
5438
|
+
/** This should be a type according to UNCL 4461
|
|
5439
|
+
to identify the type of payment. */
|
|
5440
|
+
paymentType?: PaymentType | undefined;
|
|
5441
|
+
/** BT-90
|
|
5442
|
+
If a SEPA direct debit payment mean is used, then this reference should be provided.
|
|
5443
|
+
It's the creditor identifier in SEPA, in German "Gläubiger-Identifikationsnummer".
|
|
5444
|
+
Field BT-90 in XRechnung. */
|
|
5445
|
+
paymentCreditorIdentifier?: string | undefined;
|
|
5446
|
+
/** BG-16
|
|
5447
|
+
A list of payment means that can be used to pay the invoice. */
|
|
4459
5448
|
paymentMeans?: IPaymentMeans[] | undefined;
|
|
4460
5449
|
}
|
|
4461
|
-
/**
|
|
5450
|
+
/** Indication of the instrument of payment, which may include a guarantee. Enumeration values are self-descriptive, so no comments needed here. According to UNCL 4461, see: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
|
|
5451
|
+
export declare enum PaymentType {
|
|
5452
|
+
MutuallyDefined = "MutuallyDefined",
|
|
5453
|
+
InstrumentNotDefined = "InstrumentNotDefined",
|
|
5454
|
+
AutomatedClearingHouseCredit = "AutomatedClearingHouseCredit",
|
|
5455
|
+
AutomatedClearingHouseDebit = "AutomatedClearingHouseDebit",
|
|
5456
|
+
ACHDemandDebitReversal = "ACHDemandDebitReversal",
|
|
5457
|
+
ACHDemandCreditReversal = "ACHDemandCreditReversal",
|
|
5458
|
+
ACHDemandCredit = "ACHDemandCredit",
|
|
5459
|
+
ACHDemandDebit = "ACHDemandDebit",
|
|
5460
|
+
Hold = "Hold",
|
|
5461
|
+
NationalOrRegionalClearing = "NationalOrRegionalClearing",
|
|
5462
|
+
InCash = "InCash",
|
|
5463
|
+
ACHSavingsCreditReversal = "ACHSavingsCreditReversal",
|
|
5464
|
+
ACHSavingsDebitReversal = "ACHSavingsDebitReversal",
|
|
5465
|
+
ACHSavingsCredit = "ACHSavingsCredit",
|
|
5466
|
+
ACHSavingsDebit = "ACHSavingsDebit",
|
|
5467
|
+
BookentryCredit = "BookentryCredit",
|
|
5468
|
+
BookentryDebit = "BookentryDebit",
|
|
5469
|
+
ACHDemandCashConcentrationDisbursementCCDCredit = "ACHDemandCashConcentrationDisbursementCCDCredit",
|
|
5470
|
+
ACHDemandCashConcentrationDisbursementCCDDebit = "ACHDemandCashConcentrationDisbursementCCDDebit",
|
|
5471
|
+
ACHDemandCorporateTradePaymentCTPCredit = "ACHDemandCorporateTradePaymentCTPCredit",
|
|
5472
|
+
Cheque = "Cheque",
|
|
5473
|
+
BankerSDraft = "BankerSDraft",
|
|
5474
|
+
CertifiedBankerSDraft = "CertifiedBankerSDraft",
|
|
5475
|
+
BankChequeIssuedByABankingOrSimilarEstablishment = "BankChequeIssuedByABankingOrSimilarEstablishment",
|
|
5476
|
+
BillOfExchangeAwaitingAcceptance = "BillOfExchangeAwaitingAcceptance",
|
|
5477
|
+
CertifiedCheque = "CertifiedCheque",
|
|
5478
|
+
LocalCheque = "LocalCheque",
|
|
5479
|
+
ACHDemandCorporateTradePaymentCTPDebit = "ACHDemandCorporateTradePaymentCTPDebit",
|
|
5480
|
+
ACHDemandCorporateTradeExchangeCTXCredit = "ACHDemandCorporateTradeExchangeCTXCredit",
|
|
5481
|
+
ACHDemandCorporateTradeExchangeCTXDebit = "ACHDemandCorporateTradeExchangeCTXDebit",
|
|
5482
|
+
CreditTransfer = "CreditTransfer",
|
|
5483
|
+
DebitTransfer = "DebitTransfer",
|
|
5484
|
+
ACHDemandCashConcentrationDisbursementPlusCCDCredit = "ACHDemandCashConcentrationDisbursementPlusCCDCredit",
|
|
5485
|
+
ACHDemandCashConcentrationDisbursementPlusCCDDebit = "ACHDemandCashConcentrationDisbursementPlusCCDDebit",
|
|
5486
|
+
ACHPrearrangedPaymentAndDepositPPD = "ACHPrearrangedPaymentAndDepositPPD",
|
|
5487
|
+
ACHSavingsCashConcentrationDisbursementCCDCredit = "ACHSavingsCashConcentrationDisbursementCCDCredit",
|
|
5488
|
+
ACHSavingsCashConcentrationDisbursementCCDDebit = "ACHSavingsCashConcentrationDisbursementCCDDebit",
|
|
5489
|
+
ACHSavingsCorporateTradePaymentCTPCredit = "ACHSavingsCorporateTradePaymentCTPCredit",
|
|
5490
|
+
ACHSavingsCorporateTradePaymentCTPDebit = "ACHSavingsCorporateTradePaymentCTPDebit",
|
|
5491
|
+
ACHSavingsCorporateTradeExchangeCTXCredit = "ACHSavingsCorporateTradeExchangeCTXCredit",
|
|
5492
|
+
ACHSavingsCorporateTradeExchangeCTXDebit = "ACHSavingsCorporateTradeExchangeCTXDebit",
|
|
5493
|
+
ACHSavingsCashConcentrationDisbursementPlusCCDCredit = "ACHSavingsCashConcentrationDisbursementPlusCCDCredit",
|
|
5494
|
+
PaymentToBankAccount = "PaymentToBankAccount",
|
|
5495
|
+
ACHSavingsCashConcentrationDisbursementPlusCCDDebit = "ACHSavingsCashConcentrationDisbursementPlusCCDDebit",
|
|
5496
|
+
AcceptedBillOfExchange = "AcceptedBillOfExchange",
|
|
5497
|
+
ReferencedHomeBankingCreditTransfer = "ReferencedHomeBankingCreditTransfer",
|
|
5498
|
+
InterbankDebitTransfer = "InterbankDebitTransfer",
|
|
5499
|
+
HomeBankingDebitTransfer = "HomeBankingDebitTransfer",
|
|
5500
|
+
BankCard = "BankCard",
|
|
5501
|
+
DirectDebit = "DirectDebit",
|
|
5502
|
+
PaymentByPostgiro = "PaymentByPostgiro",
|
|
5503
|
+
FRNorme697TelereglementCFONBFrenchOrganisationFor = "FRNorme697TelereglementCFONBFrenchOrganisationFor",
|
|
5504
|
+
UrgentCommercialPayment = "UrgentCommercialPayment",
|
|
5505
|
+
UrgentTreasuryPayment = "UrgentTreasuryPayment",
|
|
5506
|
+
CreditCard = "CreditCard",
|
|
5507
|
+
DebitCard = "DebitCard",
|
|
5508
|
+
Bankgiro = "Bankgiro",
|
|
5509
|
+
StandingAgreement = "StandingAgreement",
|
|
5510
|
+
SEPACreditTransfer = "SEPACreditTransfer",
|
|
5511
|
+
SEPADirectDebit = "SEPADirectDebit",
|
|
5512
|
+
PromissoryNote = "PromissoryNote",
|
|
5513
|
+
PromissoryNoteSignedByTheDebtor = "PromissoryNoteSignedByTheDebtor",
|
|
5514
|
+
PromissoryNoteSignedByTheDebtorAndEndorsedByABank = "PromissoryNoteSignedByTheDebtorAndEndorsedByABank",
|
|
5515
|
+
PromissoryNoteSignedByTheDebtorAndEndorsedByAThirdParty = "PromissoryNoteSignedByTheDebtorAndEndorsedByAThirdParty",
|
|
5516
|
+
PromissoryNoteSignedByABank = "PromissoryNoteSignedByABank",
|
|
5517
|
+
PromissoryNoteSignedByABankAndEndorsedByAnotherBank = "PromissoryNoteSignedByABankAndEndorsedByAnotherBank",
|
|
5518
|
+
PromissoryNoteSignedByAThirdParty = "PromissoryNoteSignedByAThirdParty",
|
|
5519
|
+
PromissoryNoteSignedByAThirdPartyAndEndorsedByABank = "PromissoryNoteSignedByAThirdPartyAndEndorsedByABank",
|
|
5520
|
+
OnlinePaymentService = "OnlinePaymentService",
|
|
5521
|
+
BillDrawnByTheCreditorOnTheDebtor = "BillDrawnByTheCreditorOnTheDebtor",
|
|
5522
|
+
BillDrawnByTheCreditorOnABank = "BillDrawnByTheCreditorOnABank",
|
|
5523
|
+
BillDrawnByTheCreditorEndorsedByAnotherBank = "BillDrawnByTheCreditorEndorsedByAnotherBank",
|
|
5524
|
+
BillDrawnByTheCreditorOnABankAndEndorsedByAThirdParty = "BillDrawnByTheCreditorOnABankAndEndorsedByAThirdParty",
|
|
5525
|
+
BillDrawnByTheCreditorOnAThirdParty = "BillDrawnByTheCreditorOnAThirdParty",
|
|
5526
|
+
BillDrawnByCreditorOnThirdPartyAcceptedAndEndorsedByBank = "BillDrawnByCreditorOnThirdPartyAcceptedAndEndorsedByBank",
|
|
5527
|
+
NotTransferableBankerSDraft = "NotTransferableBankerSDraft",
|
|
5528
|
+
NotTransferableLocalCheque = "NotTransferableLocalCheque",
|
|
5529
|
+
ReferenceGiro = "ReferenceGiro",
|
|
5530
|
+
UrgentGiro = "UrgentGiro",
|
|
5531
|
+
FreeFormatGiro = "FreeFormatGiro",
|
|
5532
|
+
RequestedMethodForPaymentWasNotUsed = "RequestedMethodForPaymentWasNotUsed",
|
|
5533
|
+
ClearingBetweenPartners = "ClearingBetweenPartners",
|
|
5534
|
+
JPElectronicallyRecordedMonetaryClaims = "JPElectronicallyRecordedMonetaryClaims"
|
|
5535
|
+
}
|
|
5536
|
+
/** BG-16, BG-17 & BG-18 Represents a payment means for an invoice */
|
|
4462
5537
|
export declare class PaymentMeans implements IPaymentMeans {
|
|
4463
|
-
/**
|
|
5538
|
+
/** BT-84
|
|
5539
|
+
This is typically the IBAN or account number
|
|
5540
|
+
BT-84 in XRechnung. */
|
|
4464
5541
|
accountIdentifier?: string | undefined;
|
|
4465
|
-
/**
|
|
4466
|
-
|
|
5542
|
+
/** BT-85
|
|
5543
|
+
The name for the account, typically the name of the owner for
|
|
5544
|
+
a bank account.
|
|
5545
|
+
BT-85 in XRechnung. */
|
|
4467
5546
|
accountName?: string | undefined;
|
|
4468
|
-
/**
|
|
5547
|
+
/** BT-86
|
|
5548
|
+
This can be the BIC
|
|
5549
|
+
BT-86 in XRechnung. This will be saved in BG-17. */
|
|
4469
5550
|
serviceProviderIdentifier?: string | undefined;
|
|
5551
|
+
/** BT-89
|
|
5552
|
+
If used, this is the mandate id for direct debit under which
|
|
5553
|
+
the direct debit will be performed
|
|
5554
|
+
BT-89 in XRechnung. This will be saved in BG-19. */
|
|
5555
|
+
directDebitMandateId?: string | undefined;
|
|
5556
|
+
/** BT-91
|
|
5557
|
+
If used, this is the IBAN for direct debit
|
|
5558
|
+
BT-91 in XRechnung. */
|
|
5559
|
+
directDebitIban?: string | undefined;
|
|
5560
|
+
/** BT-83
|
|
5561
|
+
The payment id, e.g. a reference number for the payment. In German,
|
|
5562
|
+
this would be called "Verwendungszweck".
|
|
5563
|
+
BT-83 in XRechnung. */
|
|
5564
|
+
paymentId?: string | undefined;
|
|
5565
|
+
/** BT-88
|
|
5566
|
+
If this is a card payment, then this is the name of the cardholder.
|
|
5567
|
+
BT-88 in XRechnung. */
|
|
5568
|
+
paymentCardHolderName?: string | undefined;
|
|
5569
|
+
/** BT-87
|
|
5570
|
+
If this is a card payment, then this is the type of card.
|
|
5571
|
+
BT-87 in XRechnung. This will be saved in BG-18. */
|
|
5572
|
+
paymentCardPrimaryAccountNumber?: string | undefined;
|
|
5573
|
+
/** If this is a card payment, then this is the type of card.
|
|
5574
|
+
This has no mapping yet in XRechnung, see:
|
|
5575
|
+
https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
|
|
5576
|
+
paymentCardNetworkId?: string | undefined;
|
|
4470
5577
|
constructor(data?: IPaymentMeans);
|
|
4471
|
-
init(_data?: any): void;
|
|
5578
|
+
init?(_data?: any): void;
|
|
4472
5579
|
static fromJS(data: any): PaymentMeans;
|
|
4473
|
-
toJSON(data?: any): any;
|
|
5580
|
+
toJSON?(data?: any): any;
|
|
4474
5581
|
}
|
|
4475
|
-
/** Represents a payment means for an invoice */
|
|
5582
|
+
/** BG-16, BG-17 & BG-18 Represents a payment means for an invoice */
|
|
4476
5583
|
export interface IPaymentMeans {
|
|
4477
|
-
/**
|
|
5584
|
+
/** BT-84
|
|
5585
|
+
This is typically the IBAN or account number
|
|
5586
|
+
BT-84 in XRechnung. */
|
|
4478
5587
|
accountIdentifier?: string | undefined;
|
|
4479
|
-
/**
|
|
4480
|
-
|
|
5588
|
+
/** BT-85
|
|
5589
|
+
The name for the account, typically the name of the owner for
|
|
5590
|
+
a bank account.
|
|
5591
|
+
BT-85 in XRechnung. */
|
|
4481
5592
|
accountName?: string | undefined;
|
|
4482
|
-
/**
|
|
5593
|
+
/** BT-86
|
|
5594
|
+
This can be the BIC
|
|
5595
|
+
BT-86 in XRechnung. This will be saved in BG-17. */
|
|
4483
5596
|
serviceProviderIdentifier?: string | undefined;
|
|
5597
|
+
/** BT-89
|
|
5598
|
+
If used, this is the mandate id for direct debit under which
|
|
5599
|
+
the direct debit will be performed
|
|
5600
|
+
BT-89 in XRechnung. This will be saved in BG-19. */
|
|
5601
|
+
directDebitMandateId?: string | undefined;
|
|
5602
|
+
/** BT-91
|
|
5603
|
+
If used, this is the IBAN for direct debit
|
|
5604
|
+
BT-91 in XRechnung. */
|
|
5605
|
+
directDebitIban?: string | undefined;
|
|
5606
|
+
/** BT-83
|
|
5607
|
+
The payment id, e.g. a reference number for the payment. In German,
|
|
5608
|
+
this would be called "Verwendungszweck".
|
|
5609
|
+
BT-83 in XRechnung. */
|
|
5610
|
+
paymentId?: string | undefined;
|
|
5611
|
+
/** BT-88
|
|
5612
|
+
If this is a card payment, then this is the name of the cardholder.
|
|
5613
|
+
BT-88 in XRechnung. */
|
|
5614
|
+
paymentCardHolderName?: string | undefined;
|
|
5615
|
+
/** BT-87
|
|
5616
|
+
If this is a card payment, then this is the type of card.
|
|
5617
|
+
BT-87 in XRechnung. This will be saved in BG-18. */
|
|
5618
|
+
paymentCardPrimaryAccountNumber?: string | undefined;
|
|
5619
|
+
/** If this is a card payment, then this is the type of card.
|
|
5620
|
+
This has no mapping yet in XRechnung, see:
|
|
5621
|
+
https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
|
|
5622
|
+
paymentCardNetworkId?: string | undefined;
|
|
4484
5623
|
}
|
|
4485
5624
|
/** Represents a document / attachment that is included with the invoice */
|
|
4486
5625
|
export declare class SupportingDocument implements ISupportingDocument {
|
|
4487
|
-
/**
|
|
5626
|
+
/** BT-122
|
|
5627
|
+
This is typically an id or a name */
|
|
4488
5628
|
documentReference?: string | undefined;
|
|
4489
|
-
/**
|
|
5629
|
+
/** BT-123
|
|
5630
|
+
A description of the document */
|
|
4490
5631
|
description?: string | undefined;
|
|
4491
|
-
/**
|
|
5632
|
+
/** BT-124
|
|
5633
|
+
A link to the document in case this is an external reference */
|
|
4492
5634
|
externalDocumentUrl?: string | undefined;
|
|
4493
|
-
/**
|
|
5635
|
+
/** BT-125
|
|
5636
|
+
The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
|
|
4494
5637
|
documentBase64?: string | undefined;
|
|
4495
|
-
/**
|
|
5638
|
+
/** BT-125
|
|
5639
|
+
This should be present if DocumentBase64 is set. */
|
|
4496
5640
|
fileName?: string | undefined;
|
|
4497
|
-
/**
|
|
5641
|
+
/** BT-125
|
|
5642
|
+
The type of the document */
|
|
4498
5643
|
documentMimeType: AttachmentMimeType;
|
|
5644
|
+
/** This is placeholder id to use instead of DocumentBase64 property for lazy-loading of documents. The use case of this is to avoid having the documents be processed in memory when they might be handled
|
|
5645
|
+
by the calling code. For example, in the AVACloud webservice, this placeholder can be used to avoid having to send the Base64 encoded document to the server and then downloading it again in the result. If this
|
|
5646
|
+
is given, the generated XML file will not be valid, since it will include the literal Guid value as a placeholder. You can use the 'xmlExportCallback' parameter in the XRechnungWriter to replace
|
|
5647
|
+
the placeholder with the actual Base64 contents of the file in this library, or just use a string replace method if you're working with the XML in a different context. */
|
|
5648
|
+
placeholderId?: string | undefined;
|
|
4499
5649
|
constructor(data?: ISupportingDocument);
|
|
4500
|
-
init(_data?: any): void;
|
|
5650
|
+
init?(_data?: any): void;
|
|
4501
5651
|
static fromJS(data: any): SupportingDocument;
|
|
4502
|
-
toJSON(data?: any): any;
|
|
5652
|
+
toJSON?(data?: any): any;
|
|
4503
5653
|
}
|
|
4504
5654
|
/** Represents a document / attachment that is included with the invoice */
|
|
4505
5655
|
export interface ISupportingDocument {
|
|
4506
|
-
/**
|
|
5656
|
+
/** BT-122
|
|
5657
|
+
This is typically an id or a name */
|
|
4507
5658
|
documentReference?: string | undefined;
|
|
4508
|
-
/**
|
|
5659
|
+
/** BT-123
|
|
5660
|
+
A description of the document */
|
|
4509
5661
|
description?: string | undefined;
|
|
4510
|
-
/**
|
|
5662
|
+
/** BT-124
|
|
5663
|
+
A link to the document in case this is an external reference */
|
|
4511
5664
|
externalDocumentUrl?: string | undefined;
|
|
4512
|
-
/**
|
|
5665
|
+
/** BT-125
|
|
5666
|
+
The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
|
|
4513
5667
|
documentBase64?: string | undefined;
|
|
4514
|
-
/**
|
|
5668
|
+
/** BT-125
|
|
5669
|
+
This should be present if DocumentBase64 is set. */
|
|
4515
5670
|
fileName?: string | undefined;
|
|
4516
|
-
/**
|
|
5671
|
+
/** BT-125
|
|
5672
|
+
The type of the document */
|
|
4517
5673
|
documentMimeType: AttachmentMimeType;
|
|
5674
|
+
/** This is placeholder id to use instead of DocumentBase64 property for lazy-loading of documents. The use case of this is to avoid having the documents be processed in memory when they might be handled
|
|
5675
|
+
by the calling code. For example, in the AVACloud webservice, this placeholder can be used to avoid having to send the Base64 encoded document to the server and then downloading it again in the result. If this
|
|
5676
|
+
is given, the generated XML file will not be valid, since it will include the literal Guid value as a placeholder. You can use the 'xmlExportCallback' parameter in the XRechnungWriter to replace
|
|
5677
|
+
the placeholder with the actual Base64 contents of the file in this library, or just use a string replace method if you're working with the XML in a different context. */
|
|
5678
|
+
placeholderId?: string | undefined;
|
|
4518
5679
|
}
|
|
4519
|
-
/** Describes a
|
|
5680
|
+
/** Describes a mime type of a document */
|
|
4520
5681
|
export declare enum AttachmentMimeType {
|
|
4521
5682
|
Unknown = "Unknown",
|
|
4522
5683
|
Pdf = "Pdf",
|
|
@@ -4528,42 +5689,54 @@ export declare enum AttachmentMimeType {
|
|
|
4528
5689
|
}
|
|
4529
5690
|
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
4530
5691
|
export declare class VatBreakdown implements IVatBreakdown {
|
|
4531
|
-
/**
|
|
5692
|
+
/** BT-116
|
|
5693
|
+
The total net amount of this VAT category */
|
|
4532
5694
|
netTaxableAmount?: number | undefined;
|
|
4533
|
-
/**
|
|
5695
|
+
/** BT-117
|
|
5696
|
+
The total VAT */
|
|
4534
5697
|
vatAmount?: number | undefined;
|
|
4535
|
-
/**
|
|
5698
|
+
/** BT-118
|
|
5699
|
+
The category of the VAT */
|
|
4536
5700
|
vatCategory: VatCategory;
|
|
4537
|
-
/**
|
|
5701
|
+
/** BT-119
|
|
5702
|
+
The actual tax rate as a decimal value,
|
|
4538
5703
|
e.g. 19% would be 0.19 */
|
|
4539
5704
|
taxRate?: number | undefined;
|
|
4540
|
-
/**
|
|
5705
|
+
/** BT-120
|
|
5706
|
+
If the VAT is exempt, there should be a description here.
|
|
4541
5707
|
For example, in reverse charge scenarios, this text
|
|
4542
5708
|
should contain a reference to "Reverse charge according to ...". */
|
|
4543
5709
|
vatExemptionReasonText?: string | undefined;
|
|
4544
|
-
/**
|
|
5710
|
+
/** BT-121
|
|
5711
|
+
A code from the VAT exemption reason code list(VATEX)“ */
|
|
4545
5712
|
vatExemptionReasonCode?: string | undefined;
|
|
4546
5713
|
constructor(data?: IVatBreakdown);
|
|
4547
|
-
init(_data?: any): void;
|
|
5714
|
+
init?(_data?: any): void;
|
|
4548
5715
|
static fromJS(data: any): VatBreakdown;
|
|
4549
|
-
toJSON(data?: any): any;
|
|
5716
|
+
toJSON?(data?: any): any;
|
|
4550
5717
|
}
|
|
4551
5718
|
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
4552
5719
|
export interface IVatBreakdown {
|
|
4553
|
-
/**
|
|
5720
|
+
/** BT-116
|
|
5721
|
+
The total net amount of this VAT category */
|
|
4554
5722
|
netTaxableAmount?: number | undefined;
|
|
4555
|
-
/**
|
|
5723
|
+
/** BT-117
|
|
5724
|
+
The total VAT */
|
|
4556
5725
|
vatAmount?: number | undefined;
|
|
4557
|
-
/**
|
|
5726
|
+
/** BT-118
|
|
5727
|
+
The category of the VAT */
|
|
4558
5728
|
vatCategory: VatCategory;
|
|
4559
|
-
/**
|
|
5729
|
+
/** BT-119
|
|
5730
|
+
The actual tax rate as a decimal value,
|
|
4560
5731
|
e.g. 19% would be 0.19 */
|
|
4561
5732
|
taxRate?: number | undefined;
|
|
4562
|
-
/**
|
|
5733
|
+
/** BT-120
|
|
5734
|
+
If the VAT is exempt, there should be a description here.
|
|
4563
5735
|
For example, in reverse charge scenarios, this text
|
|
4564
5736
|
should contain a reference to "Reverse charge according to ...". */
|
|
4565
5737
|
vatExemptionReasonText?: string | undefined;
|
|
4566
|
-
/**
|
|
5738
|
+
/** BT-121
|
|
5739
|
+
A code from the VAT exemption reason code list(VATEX)“ */
|
|
4567
5740
|
vatExemptionReasonCode?: string | undefined;
|
|
4568
5741
|
}
|
|
4569
5742
|
/** The category used in a VatBreakdown"/> */
|
|
@@ -4581,355 +5754,875 @@ export declare enum VatCategory {
|
|
|
4581
5754
|
}
|
|
4582
5755
|
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
4583
5756
|
export declare class InvoiceAllowance implements IInvoiceAllowance {
|
|
4584
|
-
/**
|
|
5757
|
+
/** BT-92
|
|
5758
|
+
The net amount of the allowance */
|
|
4585
5759
|
netAmount?: number | undefined;
|
|
4586
|
-
/**
|
|
5760
|
+
/** BT-93
|
|
5761
|
+
If this is a relative / percentage allowance, this should be set
|
|
4587
5762
|
and give the base amount that is being used for the calculation */
|
|
4588
5763
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4589
|
-
/**
|
|
5764
|
+
/** BT-94
|
|
5765
|
+
If this is a relative / percentage allowance, this should be set
|
|
4590
5766
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4591
5767
|
relativeAllowancePercentage?: number | undefined;
|
|
4592
|
-
/**
|
|
5768
|
+
/** BT-95
|
|
5769
|
+
The VAT category for the allowance */
|
|
4593
5770
|
vatCategory: VatCategory;
|
|
4594
|
-
/**
|
|
5771
|
+
/** BT-96
|
|
5772
|
+
The actual tax rate as a decimal value,
|
|
4595
5773
|
meaning 19% would be 0.19 */
|
|
4596
5774
|
vatRate?: number | undefined;
|
|
4597
|
-
/**
|
|
5775
|
+
/** BT-97
|
|
5776
|
+
A description of the allowance. This should not be set it ReasonCode
|
|
5777
|
+
is provided, otherwise this one takes precedence. */
|
|
4598
5778
|
reason?: string | undefined;
|
|
4599
|
-
/**
|
|
5779
|
+
/** BT-98
|
|
5780
|
+
A reason code for the allowance according to UNTDID 5189.
|
|
5781
|
+
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
4600
5782
|
reasonCode?: string | undefined;
|
|
5783
|
+
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
5784
|
+
and is a read-only property. */
|
|
5785
|
+
reasonType?: AllowanceReasonType | undefined;
|
|
4601
5786
|
constructor(data?: IInvoiceAllowance);
|
|
4602
|
-
init(_data?: any): void;
|
|
5787
|
+
init?(_data?: any): void;
|
|
4603
5788
|
static fromJS(data: any): InvoiceAllowance;
|
|
4604
|
-
toJSON(data?: any): any;
|
|
5789
|
+
toJSON?(data?: any): any;
|
|
4605
5790
|
}
|
|
4606
5791
|
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
4607
5792
|
export interface IInvoiceAllowance {
|
|
4608
|
-
/**
|
|
5793
|
+
/** BT-92
|
|
5794
|
+
The net amount of the allowance */
|
|
4609
5795
|
netAmount?: number | undefined;
|
|
4610
|
-
/**
|
|
5796
|
+
/** BT-93
|
|
5797
|
+
If this is a relative / percentage allowance, this should be set
|
|
4611
5798
|
and give the base amount that is being used for the calculation */
|
|
4612
5799
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4613
|
-
/**
|
|
5800
|
+
/** BT-94
|
|
5801
|
+
If this is a relative / percentage allowance, this should be set
|
|
4614
5802
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4615
5803
|
relativeAllowancePercentage?: number | undefined;
|
|
4616
|
-
/**
|
|
5804
|
+
/** BT-95
|
|
5805
|
+
The VAT category for the allowance */
|
|
4617
5806
|
vatCategory: VatCategory;
|
|
4618
|
-
/**
|
|
5807
|
+
/** BT-96
|
|
5808
|
+
The actual tax rate as a decimal value,
|
|
4619
5809
|
meaning 19% would be 0.19 */
|
|
4620
5810
|
vatRate?: number | undefined;
|
|
4621
|
-
/**
|
|
5811
|
+
/** BT-97
|
|
5812
|
+
A description of the allowance. This should not be set it ReasonCode
|
|
5813
|
+
is provided, otherwise this one takes precedence. */
|
|
4622
5814
|
reason?: string | undefined;
|
|
4623
|
-
/**
|
|
5815
|
+
/** BT-98
|
|
5816
|
+
A reason code for the allowance according to UNTDID 5189.
|
|
5817
|
+
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
4624
5818
|
reasonCode?: string | undefined;
|
|
5819
|
+
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
5820
|
+
and is a read-only property. */
|
|
5821
|
+
reasonType?: AllowanceReasonType | undefined;
|
|
5822
|
+
}
|
|
5823
|
+
/** Type specifying the identification of an allowance from UNTDID 5189. See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
5824
|
+
export declare enum AllowanceReasonType {
|
|
5825
|
+
HandlingCommission = "HandlingCommission",
|
|
5826
|
+
AmendmentCommission = "AmendmentCommission",
|
|
5827
|
+
AcceptanceCommission = "AcceptanceCommission",
|
|
5828
|
+
CommissionForObtainingAcceptance = "CommissionForObtainingAcceptance",
|
|
5829
|
+
CommissionOnDelivery = "CommissionOnDelivery",
|
|
5830
|
+
AdvisingCommission = "AdvisingCommission",
|
|
5831
|
+
ConfirmationCommission = "ConfirmationCommission",
|
|
5832
|
+
DeferredPaymentCommission = "DeferredPaymentCommission",
|
|
5833
|
+
CommissionForTakingUpDocuments = "CommissionForTakingUpDocuments",
|
|
5834
|
+
OpeningCommission = "OpeningCommission",
|
|
5835
|
+
FeeForPaymentUnderReserve = "FeeForPaymentUnderReserve",
|
|
5836
|
+
DiscrepancyFee = "DiscrepancyFee",
|
|
5837
|
+
DomicilationCommission = "DomicilationCommission",
|
|
5838
|
+
CommissionForReleaseOfGoods = "CommissionForReleaseOfGoods",
|
|
5839
|
+
CollectionCommission = "CollectionCommission",
|
|
5840
|
+
NegotiationCommission = "NegotiationCommission",
|
|
5841
|
+
ReturnCommission = "ReturnCommission",
|
|
5842
|
+
BLSplittingCharges = "BLSplittingCharges",
|
|
5843
|
+
TrustCommission = "TrustCommission",
|
|
5844
|
+
TransferCommission = "TransferCommission",
|
|
5845
|
+
CommissionForOpeningIrrevocableDocumentaryCredits = "CommissionForOpeningIrrevocableDocumentaryCredits",
|
|
5846
|
+
PreAdviceCommission = "PreAdviceCommission",
|
|
5847
|
+
SupervisoryCommission = "SupervisoryCommission",
|
|
5848
|
+
ModelCharges = "ModelCharges",
|
|
5849
|
+
RiskCommission = "RiskCommission",
|
|
5850
|
+
GuaranteeCommission = "GuaranteeCommission",
|
|
5851
|
+
ReimbursementCommission = "ReimbursementCommission",
|
|
5852
|
+
StampDuty = "StampDuty",
|
|
5853
|
+
Brokerage = "Brokerage",
|
|
5854
|
+
BankCharges = "BankCharges",
|
|
5855
|
+
BankChargesInformation = "BankChargesInformation",
|
|
5856
|
+
CourierFee = "CourierFee",
|
|
5857
|
+
PhoneFee = "PhoneFee",
|
|
5858
|
+
PostageFee = "PostageFee",
|
|
5859
|
+
SWIFTFee = "SWIFTFee",
|
|
5860
|
+
TelexFee = "TelexFee",
|
|
5861
|
+
PenaltyForLateDeliveryOfDocuments = "PenaltyForLateDeliveryOfDocuments",
|
|
5862
|
+
PenaltyForLateDeliveryOfValuationOfWorks = "PenaltyForLateDeliveryOfValuationOfWorks",
|
|
5863
|
+
PenaltyForExecutionOfWorksBehindSchedule = "PenaltyForExecutionOfWorksBehindSchedule",
|
|
5864
|
+
OtherPenalties = "OtherPenalties",
|
|
5865
|
+
BonusForWorksAheadOfSchedule = "BonusForWorksAheadOfSchedule",
|
|
5866
|
+
OtherBonus = "OtherBonus",
|
|
5867
|
+
ProjectManagementCost = "ProjectManagementCost",
|
|
5868
|
+
ProRataRetention = "ProRataRetention",
|
|
5869
|
+
ContractualRetention = "ContractualRetention",
|
|
5870
|
+
OtherRetentions = "OtherRetentions",
|
|
5871
|
+
InterestOnArrears = "InterestOnArrears",
|
|
5872
|
+
Interest = "Interest",
|
|
5873
|
+
ChargePerCreditCover = "ChargePerCreditCover",
|
|
5874
|
+
ChargePerUnusedCreditCover = "ChargePerUnusedCreditCover",
|
|
5875
|
+
MinimumCommission = "MinimumCommission",
|
|
5876
|
+
FactoringCommission = "FactoringCommission",
|
|
5877
|
+
ChamberOfCommerceCharge = "ChamberOfCommerceCharge",
|
|
5878
|
+
TransferCharges = "TransferCharges",
|
|
5879
|
+
RepatriationCharges = "RepatriationCharges",
|
|
5880
|
+
MiscellaneousCharges = "MiscellaneousCharges",
|
|
5881
|
+
ForeignExchangeCharges = "ForeignExchangeCharges",
|
|
5882
|
+
AgreedDebitInterestCharge = "AgreedDebitInterestCharge",
|
|
5883
|
+
ManufacturersConsumerDiscount = "ManufacturersConsumerDiscount",
|
|
5884
|
+
FaxAdviceCharge = "FaxAdviceCharge",
|
|
5885
|
+
DueToMilitaryStatus = "DueToMilitaryStatus",
|
|
5886
|
+
DueToWorkAccident = "DueToWorkAccident",
|
|
5887
|
+
SpecialAgreement = "SpecialAgreement",
|
|
5888
|
+
ProductionErrorDiscount = "ProductionErrorDiscount",
|
|
5889
|
+
NewOutletDiscount = "NewOutletDiscount",
|
|
5890
|
+
SampleDiscount = "SampleDiscount",
|
|
5891
|
+
EndOfRangeDiscount = "EndOfRangeDiscount",
|
|
5892
|
+
ChargeForACustomerSpecificFinish = "ChargeForACustomerSpecificFinish",
|
|
5893
|
+
IncotermDiscount = "IncotermDiscount",
|
|
5894
|
+
PointOfSalesThresholdAllowance = "PointOfSalesThresholdAllowance",
|
|
5895
|
+
TechnicalModificationCosts = "TechnicalModificationCosts",
|
|
5896
|
+
JobOrderProductionCosts = "JobOrderProductionCosts",
|
|
5897
|
+
OffPremisesCosts = "OffPremisesCosts",
|
|
5898
|
+
AdditionalProcessingCosts = "AdditionalProcessingCosts",
|
|
5899
|
+
AttestingCharge = "AttestingCharge",
|
|
5900
|
+
RushDeliverySurcharge = "RushDeliverySurcharge",
|
|
5901
|
+
SpecialConstructionCosts = "SpecialConstructionCosts",
|
|
5902
|
+
FreightCharges = "FreightCharges",
|
|
5903
|
+
PackingCharge = "PackingCharge",
|
|
5904
|
+
RepairCharge = "RepairCharge",
|
|
5905
|
+
LoadingCharge = "LoadingCharge",
|
|
5906
|
+
SetupCharge = "SetupCharge",
|
|
5907
|
+
TestingCharge = "TestingCharge",
|
|
5908
|
+
WarehousingCharge = "WarehousingCharge",
|
|
5909
|
+
GoldSurcharge = "GoldSurcharge",
|
|
5910
|
+
CopperSurcharge = "CopperSurcharge",
|
|
5911
|
+
MaterialSurchargeDeduction = "MaterialSurchargeDeduction",
|
|
5912
|
+
LeadSurcharge = "LeadSurcharge",
|
|
5913
|
+
PriceIndexSurcharge = "PriceIndexSurcharge",
|
|
5914
|
+
PlatinumSurcharge = "PlatinumSurcharge",
|
|
5915
|
+
SilverSurcharge = "SilverSurcharge",
|
|
5916
|
+
WolframSurcharge = "WolframSurcharge",
|
|
5917
|
+
AluminumSurcharge = "AluminumSurcharge",
|
|
5918
|
+
Discount = "Discount",
|
|
5919
|
+
Insurance = "Insurance",
|
|
5920
|
+
MinimumOrderMinimumBillingCharge = "MinimumOrderMinimumBillingCharge",
|
|
5921
|
+
MaterialSurchargeSpecialMaterials = "MaterialSurchargeSpecialMaterials",
|
|
5922
|
+
Surcharge = "Surcharge",
|
|
5923
|
+
SpecialRebate = "SpecialRebate",
|
|
5924
|
+
CarbonFootprintCharge = "CarbonFootprintCharge",
|
|
5925
|
+
FixedLongTerm = "FixedLongTerm",
|
|
5926
|
+
Temporary = "Temporary",
|
|
5927
|
+
Standard = "Standard",
|
|
5928
|
+
YearlyTurnover = "YearlyTurnover"
|
|
4625
5929
|
}
|
|
4626
5930
|
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
4627
5931
|
export declare class InvoiceCharge implements IInvoiceCharge {
|
|
4628
|
-
/**
|
|
5932
|
+
/** BT-99
|
|
5933
|
+
The net amount of the charge */
|
|
4629
5934
|
netAmount?: number | undefined;
|
|
4630
|
-
/**
|
|
5935
|
+
/** BT-100
|
|
5936
|
+
If this is a relative / percentage charge, this should be set
|
|
4631
5937
|
and give the base amount that is being used for the calculation */
|
|
4632
5938
|
relativeChargeBaseAmount?: number | undefined;
|
|
4633
|
-
/**
|
|
5939
|
+
/** BT-101
|
|
5940
|
+
If this is a relative / percentage charge, this should be set
|
|
4634
5941
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4635
5942
|
relativeChargePercentage?: number | undefined;
|
|
4636
|
-
/**
|
|
5943
|
+
/** BT-102
|
|
5944
|
+
The VAT category for the charge */
|
|
4637
5945
|
vatCategory: VatCategory;
|
|
4638
|
-
/**
|
|
5946
|
+
/** BT-103
|
|
5947
|
+
The actual tax rate as a decimal value,
|
|
4639
5948
|
meaning 19% would be 0.19 */
|
|
4640
5949
|
vatRate?: number | undefined;
|
|
4641
|
-
/**
|
|
5950
|
+
/** BT-104
|
|
5951
|
+
A description of the charge. This should not be set it ReasonCode
|
|
5952
|
+
is provided, otherwise this one takes precedence. */
|
|
4642
5953
|
reason?: string | undefined;
|
|
4643
|
-
/**
|
|
5954
|
+
/** BT-105
|
|
5955
|
+
A reason code for the charge according to UNTDID 7161.
|
|
5956
|
+
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
4644
5957
|
reasonCode?: string | undefined;
|
|
5958
|
+
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
5959
|
+
and is a read-only property. */
|
|
5960
|
+
reasonType?: ChargeReasonType | undefined;
|
|
4645
5961
|
constructor(data?: IInvoiceCharge);
|
|
4646
|
-
init(_data?: any): void;
|
|
5962
|
+
init?(_data?: any): void;
|
|
4647
5963
|
static fromJS(data: any): InvoiceCharge;
|
|
4648
|
-
toJSON(data?: any): any;
|
|
5964
|
+
toJSON?(data?: any): any;
|
|
4649
5965
|
}
|
|
4650
5966
|
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
4651
5967
|
export interface IInvoiceCharge {
|
|
4652
|
-
/**
|
|
5968
|
+
/** BT-99
|
|
5969
|
+
The net amount of the charge */
|
|
4653
5970
|
netAmount?: number | undefined;
|
|
4654
|
-
/**
|
|
5971
|
+
/** BT-100
|
|
5972
|
+
If this is a relative / percentage charge, this should be set
|
|
4655
5973
|
and give the base amount that is being used for the calculation */
|
|
4656
5974
|
relativeChargeBaseAmount?: number | undefined;
|
|
4657
|
-
/**
|
|
5975
|
+
/** BT-101
|
|
5976
|
+
If this is a relative / percentage charge, this should be set
|
|
4658
5977
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4659
5978
|
relativeChargePercentage?: number | undefined;
|
|
4660
|
-
/**
|
|
5979
|
+
/** BT-102
|
|
5980
|
+
The VAT category for the charge */
|
|
4661
5981
|
vatCategory: VatCategory;
|
|
4662
|
-
/**
|
|
5982
|
+
/** BT-103
|
|
5983
|
+
The actual tax rate as a decimal value,
|
|
4663
5984
|
meaning 19% would be 0.19 */
|
|
4664
5985
|
vatRate?: number | undefined;
|
|
4665
|
-
/**
|
|
5986
|
+
/** BT-104
|
|
5987
|
+
A description of the charge. This should not be set it ReasonCode
|
|
5988
|
+
is provided, otherwise this one takes precedence. */
|
|
4666
5989
|
reason?: string | undefined;
|
|
4667
|
-
/**
|
|
5990
|
+
/** BT-105
|
|
5991
|
+
A reason code for the charge according to UNTDID 7161.
|
|
5992
|
+
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
4668
5993
|
reasonCode?: string | undefined;
|
|
5994
|
+
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
5995
|
+
and is a read-only property. */
|
|
5996
|
+
reasonType?: ChargeReasonType | undefined;
|
|
5997
|
+
}
|
|
5998
|
+
/** Type specifying a special service from UNTDID 7161. See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
5999
|
+
export declare enum ChargeReasonType {
|
|
6000
|
+
Advertising = "Advertising",
|
|
6001
|
+
Telecommunication = "Telecommunication",
|
|
6002
|
+
TechnicalModification = "TechnicalModification",
|
|
6003
|
+
JobOrderProduction = "JobOrderProduction",
|
|
6004
|
+
Outlays = "Outlays",
|
|
6005
|
+
OffPremises = "OffPremises",
|
|
6006
|
+
AdditionalProcessing = "AdditionalProcessing",
|
|
6007
|
+
Attesting = "Attesting",
|
|
6008
|
+
Acceptance = "Acceptance",
|
|
6009
|
+
RushDelivery = "RushDelivery",
|
|
6010
|
+
SpecialConstruction = "SpecialConstruction",
|
|
6011
|
+
AirportFacilities = "AirportFacilities",
|
|
6012
|
+
Concession = "Concession",
|
|
6013
|
+
CompulsoryStorage = "CompulsoryStorage",
|
|
6014
|
+
FuelRemoval = "FuelRemoval",
|
|
6015
|
+
IntoPlane = "IntoPlane",
|
|
6016
|
+
Overtime = "Overtime",
|
|
6017
|
+
Tooling = "Tooling",
|
|
6018
|
+
Miscellaneous = "Miscellaneous",
|
|
6019
|
+
AdditionalPackaging = "AdditionalPackaging",
|
|
6020
|
+
Dunnage = "Dunnage",
|
|
6021
|
+
Containerisation = "Containerisation",
|
|
6022
|
+
CartonPacking = "CartonPacking",
|
|
6023
|
+
HessianWrapped = "HessianWrapped",
|
|
6024
|
+
PolyethyleneWrapPacking = "PolyethyleneWrapPacking",
|
|
6025
|
+
MiscellaneousTreatment = "MiscellaneousTreatment",
|
|
6026
|
+
EnamellingTreatment = "EnamellingTreatment",
|
|
6027
|
+
HeatTreatment = "HeatTreatment",
|
|
6028
|
+
PlatingTreatment = "PlatingTreatment",
|
|
6029
|
+
Painting = "Painting",
|
|
6030
|
+
Polishing = "Polishing",
|
|
6031
|
+
Priming = "Priming",
|
|
6032
|
+
PreservationTreatment = "PreservationTreatment",
|
|
6033
|
+
Fitting = "Fitting",
|
|
6034
|
+
Consolidation = "Consolidation",
|
|
6035
|
+
BillOfLading = "BillOfLading",
|
|
6036
|
+
Airbag = "Airbag",
|
|
6037
|
+
Transfer = "Transfer",
|
|
6038
|
+
Slipsheet = "Slipsheet",
|
|
6039
|
+
Binding = "Binding",
|
|
6040
|
+
RepairOrReplacementOfBrokenReturnablePackage = "RepairOrReplacementOfBrokenReturnablePackage",
|
|
6041
|
+
EfficientLogistics = "EfficientLogistics",
|
|
6042
|
+
Merchandising = "Merchandising",
|
|
6043
|
+
ProductMix = "ProductMix",
|
|
6044
|
+
OtherServices = "OtherServices",
|
|
6045
|
+
PickUp = "PickUp",
|
|
6046
|
+
ChronicIllness = "ChronicIllness",
|
|
6047
|
+
NewProductIntroduction = "NewProductIntroduction",
|
|
6048
|
+
DirectDelivery = "DirectDelivery",
|
|
6049
|
+
Diversion = "Diversion",
|
|
6050
|
+
Disconnect = "Disconnect",
|
|
6051
|
+
Distribution = "Distribution",
|
|
6052
|
+
HandlingOfHazardousCargo = "HandlingOfHazardousCargo",
|
|
6053
|
+
RentsAndLeases = "RentsAndLeases",
|
|
6054
|
+
LocationDifferential = "LocationDifferential",
|
|
6055
|
+
AircraftRefueling = "AircraftRefueling",
|
|
6056
|
+
FuelShippedIntoStorage = "FuelShippedIntoStorage",
|
|
6057
|
+
CashOnDelivery = "CashOnDelivery",
|
|
6058
|
+
SmallOrderProcessingService = "SmallOrderProcessingService",
|
|
6059
|
+
ClericalOrAdministrativeServices = "ClericalOrAdministrativeServices",
|
|
6060
|
+
Guarantee = "Guarantee",
|
|
6061
|
+
CollectionAndRecycling = "CollectionAndRecycling",
|
|
6062
|
+
CopyrightFeeCollection = "CopyrightFeeCollection",
|
|
6063
|
+
VeterinaryInspectionService = "VeterinaryInspectionService",
|
|
6064
|
+
PensionerService = "PensionerService",
|
|
6065
|
+
MedicineFreePassHolder = "MedicineFreePassHolder",
|
|
6066
|
+
EnvironmentalProtectionService = "EnvironmentalProtectionService",
|
|
6067
|
+
EnvironmentalCleanUpService = "EnvironmentalCleanUpService",
|
|
6068
|
+
NationalChequeProcessingServiceOutsideAccountArea = "NationalChequeProcessingServiceOutsideAccountArea",
|
|
6069
|
+
NationalPaymentServiceOutsideAccountArea = "NationalPaymentServiceOutsideAccountArea",
|
|
6070
|
+
NationalPaymentServiceWithinAccountArea = "NationalPaymentServiceWithinAccountArea",
|
|
6071
|
+
Adjustments = "Adjustments",
|
|
6072
|
+
Authentication = "Authentication",
|
|
6073
|
+
Cataloguing = "Cataloguing",
|
|
6074
|
+
Cartage = "Cartage",
|
|
6075
|
+
Certification = "Certification",
|
|
6076
|
+
CertificateOfConformance = "CertificateOfConformance",
|
|
6077
|
+
CertificateOfOrigin = "CertificateOfOrigin",
|
|
6078
|
+
Cutting = "Cutting",
|
|
6079
|
+
ConsularService = "ConsularService",
|
|
6080
|
+
CustomerCollection = "CustomerCollection",
|
|
6081
|
+
PayrollPaymentService = "PayrollPaymentService",
|
|
6082
|
+
CashTransportation = "CashTransportation",
|
|
6083
|
+
HomeBankingService = "HomeBankingService",
|
|
6084
|
+
BilateralAgreementService = "BilateralAgreementService",
|
|
6085
|
+
InsuranceBrokerageService = "InsuranceBrokerageService",
|
|
6086
|
+
ChequeGeneration = "ChequeGeneration",
|
|
6087
|
+
PreferentialMerchandisingLocation = "PreferentialMerchandisingLocation",
|
|
6088
|
+
Crane = "Crane",
|
|
6089
|
+
SpecialColourService = "SpecialColourService",
|
|
6090
|
+
Sorting = "Sorting",
|
|
6091
|
+
BatteryCollectionAndRecycling = "BatteryCollectionAndRecycling",
|
|
6092
|
+
ProductTakeBackFee = "ProductTakeBackFee",
|
|
6093
|
+
CarLoading = "CarLoading",
|
|
6094
|
+
Cleaning = "Cleaning",
|
|
6095
|
+
CigaretteStamping = "CigaretteStamping",
|
|
6096
|
+
CountAndRecount = "CountAndRecount",
|
|
6097
|
+
LayoutDesign = "LayoutDesign",
|
|
6098
|
+
DriverAssignedUnloading = "DriverAssignedUnloading",
|
|
6099
|
+
Delivery = "Delivery",
|
|
6100
|
+
Engraving = "Engraving",
|
|
6101
|
+
Expediting = "Expediting",
|
|
6102
|
+
ExchangeRateGuarantee = "ExchangeRateGuarantee",
|
|
6103
|
+
Fabrication = "Fabrication",
|
|
6104
|
+
FreightEqualization = "FreightEqualization",
|
|
6105
|
+
FreightExtraordinaryHandling = "FreightExtraordinaryHandling",
|
|
6106
|
+
FreightService = "FreightService",
|
|
6107
|
+
FillingHandling = "FillingHandling",
|
|
6108
|
+
Financing = "Financing",
|
|
6109
|
+
Grinding = "Grinding",
|
|
6110
|
+
Hose = "Hose",
|
|
6111
|
+
Handling = "Handling",
|
|
6112
|
+
HoistingAndHauling = "HoistingAndHauling",
|
|
6113
|
+
Installation = "Installation",
|
|
6114
|
+
InstallationAndWarranty = "InstallationAndWarranty",
|
|
6115
|
+
InsideDelivery = "InsideDelivery",
|
|
6116
|
+
Inspection = "Inspection",
|
|
6117
|
+
InstallationAndTraining = "InstallationAndTraining",
|
|
6118
|
+
Invoicing = "Invoicing",
|
|
6119
|
+
Koshering = "Koshering",
|
|
6120
|
+
CarrierCount = "CarrierCount",
|
|
6121
|
+
Labelling = "Labelling",
|
|
6122
|
+
Labour = "Labour",
|
|
6123
|
+
RepairAndReturn = "RepairAndReturn",
|
|
6124
|
+
Legalisation = "Legalisation",
|
|
6125
|
+
Mounting = "Mounting",
|
|
6126
|
+
MailInvoice = "MailInvoice",
|
|
6127
|
+
MailInvoiceToEachLocation = "MailInvoiceToEachLocation",
|
|
6128
|
+
NonReturnableContainers = "NonReturnableContainers",
|
|
6129
|
+
OutsideCableConnectors = "OutsideCableConnectors",
|
|
6130
|
+
InvoiceWithShipment = "InvoiceWithShipment",
|
|
6131
|
+
PhosphatizingSteelTreatment = "PhosphatizingSteelTreatment",
|
|
6132
|
+
Packing = "Packing",
|
|
6133
|
+
Palletizing = "Palletizing",
|
|
6134
|
+
Repacking = "Repacking",
|
|
6135
|
+
Repair = "Repair",
|
|
6136
|
+
ReturnableContainer = "ReturnableContainer",
|
|
6137
|
+
Restocking = "Restocking",
|
|
6138
|
+
ReDelivery = "ReDelivery",
|
|
6139
|
+
Refurbishing = "Refurbishing",
|
|
6140
|
+
RailWagonHire = "RailWagonHire",
|
|
6141
|
+
Loading = "Loading",
|
|
6142
|
+
Salvaging = "Salvaging",
|
|
6143
|
+
ShippingAndHandling = "ShippingAndHandling",
|
|
6144
|
+
SpecialPackaging = "SpecialPackaging",
|
|
6145
|
+
Stamping = "Stamping",
|
|
6146
|
+
ConsigneeUnload = "ConsigneeUnload",
|
|
6147
|
+
ShrinkWrap = "ShrinkWrap",
|
|
6148
|
+
SpecialHandling = "SpecialHandling",
|
|
6149
|
+
SpecialFinish = "SpecialFinish",
|
|
6150
|
+
SetUp = "SetUp",
|
|
6151
|
+
TankRenting = "TankRenting",
|
|
6152
|
+
Testing = "Testing",
|
|
6153
|
+
TransportationThirdPartyBilling = "TransportationThirdPartyBilling",
|
|
6154
|
+
TransportationByVendor = "TransportationByVendor",
|
|
6155
|
+
DropYard = "DropYard",
|
|
6156
|
+
DropDock = "DropDock",
|
|
6157
|
+
Warehousing = "Warehousing",
|
|
6158
|
+
CombineAllSameDayShipment = "CombineAllSameDayShipment",
|
|
6159
|
+
SplitPickUp = "SplitPickUp",
|
|
6160
|
+
MutuallyDefined = "MutuallyDefined"
|
|
4669
6161
|
}
|
|
4670
6162
|
/** Represents a single invoice line item */
|
|
4671
6163
|
export declare class InvoiceLineItem implements IInvoiceLineItem {
|
|
4672
|
-
/**
|
|
6164
|
+
/** BT-126
|
|
6165
|
+
An unique identifier for the line item */
|
|
4673
6166
|
identifier?: string | undefined;
|
|
4674
|
-
/**
|
|
6167
|
+
/** BT-127
|
|
6168
|
+
An unstructured note to classify line items */
|
|
4675
6169
|
note?: string | undefined;
|
|
4676
|
-
/**
|
|
6170
|
+
/** BT-128
|
|
6171
|
+
A seller-defined object identifier for this line item,
|
|
4677
6172
|
meaning an identifier for the actual line. This could be
|
|
4678
6173
|
a numbering sequence or a reference to a product. */
|
|
4679
6174
|
objectIdentifier?: string | undefined;
|
|
4680
|
-
/**
|
|
6175
|
+
/** BT-129
|
|
6176
|
+
The actual invoiced quantity of the line item */
|
|
4681
6177
|
quantity?: number | undefined;
|
|
4682
|
-
/**
|
|
6178
|
+
/** BT-130
|
|
6179
|
+
A code for the unit of the quantity. This should be a code as defined
|
|
4683
6180
|
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
4684
6181
|
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
4685
|
-
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names)
|
|
6182
|
+
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names).
|
|
6183
|
+
See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931 */
|
|
4686
6184
|
unitCode?: string | undefined;
|
|
4687
|
-
/**
|
|
6185
|
+
/** BT-131
|
|
6186
|
+
The net amount for this line item. This is the total price for positions */
|
|
4688
6187
|
netAmount?: number | undefined;
|
|
4689
|
-
/**
|
|
6188
|
+
/** BT-132
|
|
6189
|
+
A reference to an item in the buyers purachase order */
|
|
4690
6190
|
purchaseOrderReference?: string | undefined;
|
|
4691
|
-
/**
|
|
6191
|
+
/** BG-26
|
|
6192
|
+
Information about the invoice period for this line item. */
|
|
4692
6193
|
lineItemPeriod?: InvoicePeriod | undefined;
|
|
4693
|
-
/**
|
|
6194
|
+
/** BG-27
|
|
6195
|
+
Allowances specific to this line item */
|
|
4694
6196
|
allowances?: LineItemAllowance[] | undefined;
|
|
4695
|
-
/**
|
|
6197
|
+
/** BG-28
|
|
6198
|
+
charges specific to this line item */
|
|
4696
6199
|
charges?: LineItemCharge[] | undefined;
|
|
4697
|
-
/**
|
|
6200
|
+
/** BG-29
|
|
6201
|
+
Price details for this line item. */
|
|
4698
6202
|
priceDetails?: LineItemPriceDetail | undefined;
|
|
4699
|
-
/**
|
|
6203
|
+
/** BG-30
|
|
6204
|
+
VAT information for this line item */
|
|
4700
6205
|
vatInformation?: LineItemVatInformation[] | undefined;
|
|
4701
|
-
/**
|
|
6206
|
+
/** BG-31
|
|
6207
|
+
Information about this line item */
|
|
4702
6208
|
itemInformation?: LineItemInformation | undefined;
|
|
4703
|
-
/**
|
|
6209
|
+
/** BG-DEX-01
|
|
6210
|
+
Line items can be nested, in which case this property holds the sub items */
|
|
4704
6211
|
subItems?: InvoiceLineItem[] | undefined;
|
|
4705
6212
|
constructor(data?: IInvoiceLineItem);
|
|
4706
|
-
init(_data?: any): void;
|
|
6213
|
+
init?(_data?: any): void;
|
|
4707
6214
|
static fromJS(data: any): InvoiceLineItem;
|
|
4708
|
-
toJSON(data?: any): any;
|
|
6215
|
+
toJSON?(data?: any): any;
|
|
4709
6216
|
}
|
|
4710
6217
|
/** Represents a single invoice line item */
|
|
4711
6218
|
export interface IInvoiceLineItem {
|
|
4712
|
-
/**
|
|
6219
|
+
/** BT-126
|
|
6220
|
+
An unique identifier for the line item */
|
|
4713
6221
|
identifier?: string | undefined;
|
|
4714
|
-
/**
|
|
6222
|
+
/** BT-127
|
|
6223
|
+
An unstructured note to classify line items */
|
|
4715
6224
|
note?: string | undefined;
|
|
4716
|
-
/**
|
|
6225
|
+
/** BT-128
|
|
6226
|
+
A seller-defined object identifier for this line item,
|
|
4717
6227
|
meaning an identifier for the actual line. This could be
|
|
4718
6228
|
a numbering sequence or a reference to a product. */
|
|
4719
6229
|
objectIdentifier?: string | undefined;
|
|
4720
|
-
/**
|
|
6230
|
+
/** BT-129
|
|
6231
|
+
The actual invoiced quantity of the line item */
|
|
4721
6232
|
quantity?: number | undefined;
|
|
4722
|
-
/**
|
|
6233
|
+
/** BT-130
|
|
6234
|
+
A code for the unit of the quantity. This should be a code as defined
|
|
4723
6235
|
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
4724
6236
|
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
4725
|
-
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names)
|
|
6237
|
+
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names).
|
|
6238
|
+
See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931 */
|
|
4726
6239
|
unitCode?: string | undefined;
|
|
4727
|
-
/**
|
|
6240
|
+
/** BT-131
|
|
6241
|
+
The net amount for this line item. This is the total price for positions */
|
|
4728
6242
|
netAmount?: number | undefined;
|
|
4729
|
-
/**
|
|
6243
|
+
/** BT-132
|
|
6244
|
+
A reference to an item in the buyers purachase order */
|
|
4730
6245
|
purchaseOrderReference?: string | undefined;
|
|
4731
|
-
/**
|
|
6246
|
+
/** BG-26
|
|
6247
|
+
Information about the invoice period for this line item. */
|
|
4732
6248
|
lineItemPeriod?: IInvoicePeriod | undefined;
|
|
4733
|
-
/**
|
|
6249
|
+
/** BG-27
|
|
6250
|
+
Allowances specific to this line item */
|
|
4734
6251
|
allowances?: ILineItemAllowance[] | undefined;
|
|
4735
|
-
/**
|
|
6252
|
+
/** BG-28
|
|
6253
|
+
charges specific to this line item */
|
|
4736
6254
|
charges?: ILineItemCharge[] | undefined;
|
|
4737
|
-
/**
|
|
6255
|
+
/** BG-29
|
|
6256
|
+
Price details for this line item. */
|
|
4738
6257
|
priceDetails?: ILineItemPriceDetail | undefined;
|
|
4739
|
-
/**
|
|
6258
|
+
/** BG-30
|
|
6259
|
+
VAT information for this line item */
|
|
4740
6260
|
vatInformation?: ILineItemVatInformation[] | undefined;
|
|
4741
|
-
/**
|
|
6261
|
+
/** BG-31
|
|
6262
|
+
Information about this line item */
|
|
4742
6263
|
itemInformation?: ILineItemInformation | undefined;
|
|
4743
|
-
/**
|
|
6264
|
+
/** BG-DEX-01
|
|
6265
|
+
Line items can be nested, in which case this property holds the sub items */
|
|
4744
6266
|
subItems?: IInvoiceLineItem[] | undefined;
|
|
4745
6267
|
}
|
|
4746
6268
|
/** Allowance for a single line item */
|
|
4747
6269
|
export declare class LineItemAllowance implements ILineItemAllowance {
|
|
4748
|
-
/**
|
|
6270
|
+
/** BT-136
|
|
6271
|
+
The net amount of the allowance */
|
|
4749
6272
|
netAmount?: number | undefined;
|
|
4750
|
-
/**
|
|
6273
|
+
/** BT-137
|
|
6274
|
+
If this is a relative / percentage allowance, this should be set
|
|
4751
6275
|
and give the base amount that is being used for the calculation */
|
|
4752
6276
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4753
|
-
/**
|
|
6277
|
+
/** BT-138
|
|
6278
|
+
If this is a relative / percentage allowance, this should be set
|
|
4754
6279
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4755
6280
|
relativeAllowancePercentage?: number | undefined;
|
|
4756
|
-
/**
|
|
6281
|
+
/** BT-139
|
|
6282
|
+
A description of the allowance. */
|
|
4757
6283
|
reason?: string | undefined;
|
|
4758
|
-
/**
|
|
6284
|
+
/** BT-140
|
|
6285
|
+
A reason code for the allowance according to UNTDID 5189. Should be a code
|
|
6286
|
+
from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
4759
6287
|
reasonCode?: string | undefined;
|
|
6288
|
+
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
6289
|
+
and is a read-only property. */
|
|
6290
|
+
reasonType?: AllowanceReasonType | undefined;
|
|
4760
6291
|
constructor(data?: ILineItemAllowance);
|
|
4761
|
-
init(_data?: any): void;
|
|
6292
|
+
init?(_data?: any): void;
|
|
4762
6293
|
static fromJS(data: any): LineItemAllowance;
|
|
4763
|
-
toJSON(data?: any): any;
|
|
6294
|
+
toJSON?(data?: any): any;
|
|
4764
6295
|
}
|
|
4765
6296
|
/** Allowance for a single line item */
|
|
4766
6297
|
export interface ILineItemAllowance {
|
|
4767
|
-
/**
|
|
6298
|
+
/** BT-136
|
|
6299
|
+
The net amount of the allowance */
|
|
4768
6300
|
netAmount?: number | undefined;
|
|
4769
|
-
/**
|
|
6301
|
+
/** BT-137
|
|
6302
|
+
If this is a relative / percentage allowance, this should be set
|
|
4770
6303
|
and give the base amount that is being used for the calculation */
|
|
4771
6304
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4772
|
-
/**
|
|
6305
|
+
/** BT-138
|
|
6306
|
+
If this is a relative / percentage allowance, this should be set
|
|
4773
6307
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4774
6308
|
relativeAllowancePercentage?: number | undefined;
|
|
4775
|
-
/**
|
|
6309
|
+
/** BT-139
|
|
6310
|
+
A description of the allowance. */
|
|
4776
6311
|
reason?: string | undefined;
|
|
4777
|
-
/**
|
|
6312
|
+
/** BT-140
|
|
6313
|
+
A reason code for the allowance according to UNTDID 5189. Should be a code
|
|
6314
|
+
from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
4778
6315
|
reasonCode?: string | undefined;
|
|
6316
|
+
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
6317
|
+
and is a read-only property. */
|
|
6318
|
+
reasonType?: AllowanceReasonType | undefined;
|
|
4779
6319
|
}
|
|
4780
6320
|
/** Charge for a single line item */
|
|
4781
6321
|
export declare class LineItemCharge implements ILineItemCharge {
|
|
4782
|
-
/**
|
|
6322
|
+
/** BT-141
|
|
6323
|
+
The net amount of the charge */
|
|
4783
6324
|
netAmount?: number | undefined;
|
|
4784
|
-
/**
|
|
6325
|
+
/** BT-142
|
|
6326
|
+
If this is a relative / percentage charge, this should be set
|
|
4785
6327
|
and give the base amount that is being used for the calculation */
|
|
4786
6328
|
relativeChargeBaseAmount?: number | undefined;
|
|
4787
|
-
/**
|
|
6329
|
+
/** BT-143
|
|
6330
|
+
If this is a relative / percentage charge, this should be set
|
|
4788
6331
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4789
6332
|
relativeChargePercentage?: number | undefined;
|
|
4790
|
-
/**
|
|
6333
|
+
/** BT-144
|
|
6334
|
+
A description of the charge. */
|
|
4791
6335
|
reason?: string | undefined;
|
|
4792
|
-
/**
|
|
6336
|
+
/** BT-145
|
|
6337
|
+
A reason code for the charge according to UNTDID 7161.
|
|
6338
|
+
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
4793
6339
|
reasonCode?: string | undefined;
|
|
6340
|
+
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
6341
|
+
and is a read-only property. */
|
|
6342
|
+
reasonType?: ChargeReasonType | undefined;
|
|
4794
6343
|
constructor(data?: ILineItemCharge);
|
|
4795
|
-
init(_data?: any): void;
|
|
6344
|
+
init?(_data?: any): void;
|
|
4796
6345
|
static fromJS(data: any): LineItemCharge;
|
|
4797
|
-
toJSON(data?: any): any;
|
|
6346
|
+
toJSON?(data?: any): any;
|
|
4798
6347
|
}
|
|
4799
6348
|
/** Charge for a single line item */
|
|
4800
6349
|
export interface ILineItemCharge {
|
|
4801
|
-
/**
|
|
6350
|
+
/** BT-141
|
|
6351
|
+
The net amount of the charge */
|
|
4802
6352
|
netAmount?: number | undefined;
|
|
4803
|
-
/**
|
|
6353
|
+
/** BT-142
|
|
6354
|
+
If this is a relative / percentage charge, this should be set
|
|
4804
6355
|
and give the base amount that is being used for the calculation */
|
|
4805
6356
|
relativeChargeBaseAmount?: number | undefined;
|
|
4806
|
-
/**
|
|
6357
|
+
/** BT-143
|
|
6358
|
+
If this is a relative / percentage charge, this should be set
|
|
4807
6359
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4808
6360
|
relativeChargePercentage?: number | undefined;
|
|
4809
|
-
/**
|
|
6361
|
+
/** BT-144
|
|
6362
|
+
A description of the charge. */
|
|
4810
6363
|
reason?: string | undefined;
|
|
4811
|
-
/**
|
|
6364
|
+
/** BT-145
|
|
6365
|
+
A reason code for the charge according to UNTDID 7161.
|
|
6366
|
+
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
4812
6367
|
reasonCode?: string | undefined;
|
|
6368
|
+
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
6369
|
+
and is a read-only property. */
|
|
6370
|
+
reasonType?: ChargeReasonType | undefined;
|
|
4813
6371
|
}
|
|
4814
6372
|
/** Price details about a line item */
|
|
4815
6373
|
export declare class LineItemPriceDetail implements ILineItemPriceDetail {
|
|
4816
|
-
/**
|
|
6374
|
+
/** BT-146
|
|
6375
|
+
The net price of this line item. This is the unit price */
|
|
4817
6376
|
netPrice?: number | undefined;
|
|
4818
|
-
/**
|
|
6377
|
+
/** BT-147
|
|
6378
|
+
A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
4819
6379
|
and the actual invoiced price GrossPrice. */
|
|
4820
6380
|
absoluteDiscountPerItem?: number | undefined;
|
|
4821
|
-
/**
|
|
6381
|
+
/** BT-148
|
|
6382
|
+
The gross price of this line item, meaning the price without taxes
|
|
4822
6383
|
that will be invoiced */
|
|
4823
6384
|
grossPrice?: number | undefined;
|
|
4824
|
-
/**
|
|
6385
|
+
/** BT-149
|
|
6386
|
+
The quantity for which this price is valid. In combination with the NetPrice,
|
|
6387
|
+
you basically specify the denominator of the unit price for a line item. */
|
|
4825
6388
|
baseQuantity?: number | undefined;
|
|
4826
|
-
/**
|
|
6389
|
+
/** BT-150
|
|
6390
|
+
A code representing the unit for the base quantity */
|
|
4827
6391
|
baseQuantityUnitCode?: string | undefined;
|
|
4828
6392
|
constructor(data?: ILineItemPriceDetail);
|
|
4829
|
-
init(_data?: any): void;
|
|
6393
|
+
init?(_data?: any): void;
|
|
4830
6394
|
static fromJS(data: any): LineItemPriceDetail;
|
|
4831
|
-
toJSON(data?: any): any;
|
|
6395
|
+
toJSON?(data?: any): any;
|
|
4832
6396
|
}
|
|
4833
6397
|
/** Price details about a line item */
|
|
4834
6398
|
export interface ILineItemPriceDetail {
|
|
4835
|
-
/**
|
|
6399
|
+
/** BT-146
|
|
6400
|
+
The net price of this line item. This is the unit price */
|
|
4836
6401
|
netPrice?: number | undefined;
|
|
4837
|
-
/**
|
|
6402
|
+
/** BT-147
|
|
6403
|
+
A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
4838
6404
|
and the actual invoiced price GrossPrice. */
|
|
4839
6405
|
absoluteDiscountPerItem?: number | undefined;
|
|
4840
|
-
/**
|
|
6406
|
+
/** BT-148
|
|
6407
|
+
The gross price of this line item, meaning the price without taxes
|
|
4841
6408
|
that will be invoiced */
|
|
4842
6409
|
grossPrice?: number | undefined;
|
|
4843
|
-
/**
|
|
6410
|
+
/** BT-149
|
|
6411
|
+
The quantity for which this price is valid. In combination with the NetPrice,
|
|
6412
|
+
you basically specify the denominator of the unit price for a line item. */
|
|
4844
6413
|
baseQuantity?: number | undefined;
|
|
4845
|
-
/**
|
|
6414
|
+
/** BT-150
|
|
6415
|
+
A code representing the unit for the base quantity */
|
|
4846
6416
|
baseQuantityUnitCode?: string | undefined;
|
|
4847
6417
|
}
|
|
4848
6418
|
/** VAT information for a single line item */
|
|
4849
6419
|
export declare class LineItemVatInformation implements ILineItemVatInformation {
|
|
4850
|
-
/**
|
|
6420
|
+
/** BT-151
|
|
6421
|
+
The VAT category for the charge */
|
|
4851
6422
|
vatCategory: VatCategory;
|
|
4852
|
-
/**
|
|
6423
|
+
/** BT-152
|
|
6424
|
+
The actual tax rate as a decimal value,
|
|
4853
6425
|
meaning 19% would be 0.19 */
|
|
4854
6426
|
vatRate?: number | undefined;
|
|
4855
6427
|
constructor(data?: ILineItemVatInformation);
|
|
4856
|
-
init(_data?: any): void;
|
|
6428
|
+
init?(_data?: any): void;
|
|
4857
6429
|
static fromJS(data: any): LineItemVatInformation;
|
|
4858
|
-
toJSON(data?: any): any;
|
|
6430
|
+
toJSON?(data?: any): any;
|
|
4859
6431
|
}
|
|
4860
6432
|
/** VAT information for a single line item */
|
|
4861
6433
|
export interface ILineItemVatInformation {
|
|
4862
|
-
/**
|
|
6434
|
+
/** BT-151
|
|
6435
|
+
The VAT category for the charge */
|
|
4863
6436
|
vatCategory: VatCategory;
|
|
4864
|
-
/**
|
|
6437
|
+
/** BT-152
|
|
6438
|
+
The actual tax rate as a decimal value,
|
|
4865
6439
|
meaning 19% would be 0.19 */
|
|
4866
6440
|
vatRate?: number | undefined;
|
|
4867
6441
|
}
|
|
4868
6442
|
/** Information about a single line item */
|
|
4869
6443
|
export declare class LineItemInformation implements ILineItemInformation {
|
|
4870
|
-
/**
|
|
6444
|
+
/** BT-153
|
|
6445
|
+
A name for the line item */
|
|
4871
6446
|
name?: string | undefined;
|
|
4872
|
-
/**
|
|
6447
|
+
/** BT-154
|
|
6448
|
+
A description for the line item */
|
|
4873
6449
|
description?: string | undefined;
|
|
4874
|
-
/**
|
|
6450
|
+
/** BT-155
|
|
6451
|
+
An identifier assigned by the seller, e.g. an internal article number */
|
|
4875
6452
|
sellerIdentifier?: string | undefined;
|
|
4876
|
-
/**
|
|
6453
|
+
/** BT-156
|
|
6454
|
+
An identifier assigned by the buyer, e.g. an internal article number */
|
|
4877
6455
|
buyerIdentifier?: string | undefined;
|
|
4878
|
-
/**
|
|
6456
|
+
/** BT-157
|
|
6457
|
+
A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
4879
6458
|
standardIdentifier?: string | undefined;
|
|
4880
|
-
/**
|
|
6459
|
+
/** BT-157
|
|
6460
|
+
If used together with StandardIdentifier, this is the scheme identifier
|
|
6461
|
+
for which standard is used. */
|
|
6462
|
+
standardSchemeId?: string | undefined;
|
|
6463
|
+
/** BT-158
|
|
6464
|
+
A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
|
|
4881
6465
|
classificationIdentifiers?: string[] | undefined;
|
|
4882
|
-
/**
|
|
6466
|
+
/** BT-158
|
|
6467
|
+
This is used in connection with ClassificationIdentifiers. It is the scheme identifier
|
|
6468
|
+
for each identifier. If this list is used, it should have the same length as ClassificationIdentifiers, with null or empty values used
|
|
6469
|
+
for non-existing scheme identifiers. */
|
|
6470
|
+
classificationTypes?: string[] | undefined;
|
|
6471
|
+
/** BT-159
|
|
6472
|
+
The origin country code according to ISO 3166-1 in 2 letter format */
|
|
4883
6473
|
countryOfOrigin?: string | undefined;
|
|
4884
|
-
/**
|
|
6474
|
+
/** BG-32
|
|
6475
|
+
Optional additional attributes for this line item */
|
|
4885
6476
|
attributes?: LineItemAttribute[] | undefined;
|
|
4886
6477
|
constructor(data?: ILineItemInformation);
|
|
4887
|
-
init(_data?: any): void;
|
|
6478
|
+
init?(_data?: any): void;
|
|
4888
6479
|
static fromJS(data: any): LineItemInformation;
|
|
4889
|
-
toJSON(data?: any): any;
|
|
6480
|
+
toJSON?(data?: any): any;
|
|
4890
6481
|
}
|
|
4891
6482
|
/** Information about a single line item */
|
|
4892
6483
|
export interface ILineItemInformation {
|
|
4893
|
-
/**
|
|
6484
|
+
/** BT-153
|
|
6485
|
+
A name for the line item */
|
|
4894
6486
|
name?: string | undefined;
|
|
4895
|
-
/**
|
|
6487
|
+
/** BT-154
|
|
6488
|
+
A description for the line item */
|
|
4896
6489
|
description?: string | undefined;
|
|
4897
|
-
/**
|
|
6490
|
+
/** BT-155
|
|
6491
|
+
An identifier assigned by the seller, e.g. an internal article number */
|
|
4898
6492
|
sellerIdentifier?: string | undefined;
|
|
4899
|
-
/**
|
|
6493
|
+
/** BT-156
|
|
6494
|
+
An identifier assigned by the buyer, e.g. an internal article number */
|
|
4900
6495
|
buyerIdentifier?: string | undefined;
|
|
4901
|
-
/**
|
|
6496
|
+
/** BT-157
|
|
6497
|
+
A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
4902
6498
|
standardIdentifier?: string | undefined;
|
|
4903
|
-
/**
|
|
6499
|
+
/** BT-157
|
|
6500
|
+
If used together with StandardIdentifier, this is the scheme identifier
|
|
6501
|
+
for which standard is used. */
|
|
6502
|
+
standardSchemeId?: string | undefined;
|
|
6503
|
+
/** BT-158
|
|
6504
|
+
A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
|
|
4904
6505
|
classificationIdentifiers?: string[] | undefined;
|
|
4905
|
-
/**
|
|
6506
|
+
/** BT-158
|
|
6507
|
+
This is used in connection with ClassificationIdentifiers. It is the scheme identifier
|
|
6508
|
+
for each identifier. If this list is used, it should have the same length as ClassificationIdentifiers, with null or empty values used
|
|
6509
|
+
for non-existing scheme identifiers. */
|
|
6510
|
+
classificationTypes?: string[] | undefined;
|
|
6511
|
+
/** BT-159
|
|
6512
|
+
The origin country code according to ISO 3166-1 in 2 letter format */
|
|
4906
6513
|
countryOfOrigin?: string | undefined;
|
|
4907
|
-
/**
|
|
6514
|
+
/** BG-32
|
|
6515
|
+
Optional additional attributes for this line item */
|
|
4908
6516
|
attributes?: ILineItemAttribute[] | undefined;
|
|
4909
6517
|
}
|
|
4910
6518
|
/** A key-value pair for additional information */
|
|
4911
6519
|
export declare class LineItemAttribute implements ILineItemAttribute {
|
|
4912
|
-
/**
|
|
6520
|
+
/** BT-160
|
|
6521
|
+
The key / name of the attribute */
|
|
4913
6522
|
name: string;
|
|
4914
|
-
/**
|
|
6523
|
+
/** BT-161
|
|
6524
|
+
The value of the attribute */
|
|
4915
6525
|
value?: string | undefined;
|
|
4916
6526
|
constructor(data?: ILineItemAttribute);
|
|
4917
|
-
init(_data?: any): void;
|
|
6527
|
+
init?(_data?: any): void;
|
|
4918
6528
|
static fromJS(data: any): LineItemAttribute;
|
|
4919
|
-
toJSON(data?: any): any;
|
|
6529
|
+
toJSON?(data?: any): any;
|
|
4920
6530
|
}
|
|
4921
6531
|
/** A key-value pair for additional information */
|
|
4922
6532
|
export interface ILineItemAttribute {
|
|
4923
|
-
/**
|
|
6533
|
+
/** BT-160
|
|
6534
|
+
The key / name of the attribute */
|
|
4924
6535
|
name: string;
|
|
4925
|
-
/**
|
|
6536
|
+
/** BT-161
|
|
6537
|
+
The value of the attribute */
|
|
4926
6538
|
value?: string | undefined;
|
|
4927
6539
|
}
|
|
4928
6540
|
/** This enum represents the source of an invoice, e.g. from which format it was imported */
|
|
4929
6541
|
export declare enum SourceType {
|
|
4930
6542
|
Self = "Self",
|
|
4931
6543
|
Ubl = "Ubl",
|
|
4932
|
-
Cii = "Cii"
|
|
6544
|
+
Cii = "Cii",
|
|
6545
|
+
FacturX = "FacturX"
|
|
6546
|
+
}
|
|
6547
|
+
/** Represents data related to Factur-X, including additional payment terms. */
|
|
6548
|
+
export declare class FacturXData implements IFacturXData {
|
|
6549
|
+
/** Factur-X specific routing ID, "Leitweg-ID" in German. This is typically
|
|
6550
|
+
required in public administration invoicing in Germany. */
|
|
6551
|
+
routingId?: string | undefined;
|
|
6552
|
+
/** The field BT-20 in XRechnung can only hold one payment term, but Factur-X / ZUGFeRD
|
|
6553
|
+
allows multiple payment terms. If the invoice was originally created in Factur-X / ZUGFeRD format,
|
|
6554
|
+
then this property holds all additional payment terms except the first one. Similar,
|
|
6555
|
+
on export, this property is used to export additional payment terms to Factur-X / ZUGFeRD.
|
|
6556
|
+
Factur-X / ZUGFeRD also allows a more detailled representation of payment terms,
|
|
6557
|
+
so they are given in a special object instead of just a string.
|
|
6558
|
+
If those are present, the regular PaymentTerms will be ignored on export
|
|
6559
|
+
to the CII / Factur-X format, as the information in this object is more detailled. */
|
|
6560
|
+
facturXPaymentTerms?: FacturXPaymentTerm[] | undefined;
|
|
6561
|
+
constructor(data?: IFacturXData);
|
|
6562
|
+
init?(_data?: any): void;
|
|
6563
|
+
static fromJS(data: any): FacturXData;
|
|
6564
|
+
toJSON?(data?: any): any;
|
|
6565
|
+
}
|
|
6566
|
+
/** Represents data related to Factur-X, including additional payment terms. */
|
|
6567
|
+
export interface IFacturXData {
|
|
6568
|
+
/** Factur-X specific routing ID, "Leitweg-ID" in German. This is typically
|
|
6569
|
+
required in public administration invoicing in Germany. */
|
|
6570
|
+
routingId?: string | undefined;
|
|
6571
|
+
/** The field BT-20 in XRechnung can only hold one payment term, but Factur-X / ZUGFeRD
|
|
6572
|
+
allows multiple payment terms. If the invoice was originally created in Factur-X / ZUGFeRD format,
|
|
6573
|
+
then this property holds all additional payment terms except the first one. Similar,
|
|
6574
|
+
on export, this property is used to export additional payment terms to Factur-X / ZUGFeRD.
|
|
6575
|
+
Factur-X / ZUGFeRD also allows a more detailled representation of payment terms,
|
|
6576
|
+
so they are given in a special object instead of just a string.
|
|
6577
|
+
If those are present, the regular PaymentTerms will be ignored on export
|
|
6578
|
+
to the CII / Factur-X format, as the information in this object is more detailled. */
|
|
6579
|
+
facturXPaymentTerms?: IFacturXPaymentTerm[] | undefined;
|
|
6580
|
+
}
|
|
6581
|
+
/** Factur-X / ZUGFeRD allows a more detailled representation of payment discount terms. If those are present in the invoice, they will be stored in this object. */
|
|
6582
|
+
export declare class FacturXPaymentTerm implements IFacturXPaymentTerm {
|
|
6583
|
+
/** A text description of the payment discount term. BT-20 in XRechnung,
|
|
6584
|
+
but this parent object is only used for Factur-X / ZUGFeRD and holds
|
|
6585
|
+
more detailled information about the payment term. */
|
|
6586
|
+
description?: string | undefined;
|
|
6587
|
+
/** The date until which the payment term applies. */
|
|
6588
|
+
dueDate?: Date | undefined;
|
|
6589
|
+
/** The base amount unto which the discount applies. */
|
|
6590
|
+
baseAmount?: number | undefined;
|
|
6591
|
+
/** The actual discount amount that will be deducted if the payment is done within the specified period. */
|
|
6592
|
+
actualDiscountAmount?: number | undefined;
|
|
6593
|
+
/** The base date for calculating the discount period. This is typically the invoice date. */
|
|
6594
|
+
baseDate?: Date | undefined;
|
|
6595
|
+
/** The duration of the discount period, e.g. "30" for 30 days. */
|
|
6596
|
+
periodMeasure?: number | undefined;
|
|
6597
|
+
/** The unit in which the period is specified, e.g. "DAY". */
|
|
6598
|
+
periodMeasureUnitCode?: string | undefined;
|
|
6599
|
+
/** The percentage of the discount, e.g. ".02" for 2%. */
|
|
6600
|
+
calculationPercent?: number | undefined;
|
|
6601
|
+
constructor(data?: IFacturXPaymentTerm);
|
|
6602
|
+
init?(_data?: any): void;
|
|
6603
|
+
static fromJS(data: any): FacturXPaymentTerm;
|
|
6604
|
+
toJSON?(data?: any): any;
|
|
6605
|
+
}
|
|
6606
|
+
/** Factur-X / ZUGFeRD allows a more detailled representation of payment discount terms. If those are present in the invoice, they will be stored in this object. */
|
|
6607
|
+
export interface IFacturXPaymentTerm {
|
|
6608
|
+
/** A text description of the payment discount term. BT-20 in XRechnung,
|
|
6609
|
+
but this parent object is only used for Factur-X / ZUGFeRD and holds
|
|
6610
|
+
more detailled information about the payment term. */
|
|
6611
|
+
description?: string | undefined;
|
|
6612
|
+
/** The date until which the payment term applies. */
|
|
6613
|
+
dueDate?: Date | undefined;
|
|
6614
|
+
/** The base amount unto which the discount applies. */
|
|
6615
|
+
baseAmount?: number | undefined;
|
|
6616
|
+
/** The actual discount amount that will be deducted if the payment is done within the specified period. */
|
|
6617
|
+
actualDiscountAmount?: number | undefined;
|
|
6618
|
+
/** The base date for calculating the discount period. This is typically the invoice date. */
|
|
6619
|
+
baseDate?: Date | undefined;
|
|
6620
|
+
/** The duration of the discount period, e.g. "30" for 30 days. */
|
|
6621
|
+
periodMeasure?: number | undefined;
|
|
6622
|
+
/** The unit in which the period is specified, e.g. "DAY". */
|
|
6623
|
+
periodMeasureUnitCode?: string | undefined;
|
|
6624
|
+
/** The percentage of the discount, e.g. ".02" for 2%. */
|
|
6625
|
+
calculationPercent?: number | undefined;
|
|
4933
6626
|
}
|
|
4934
6627
|
/** This is a wrapper class that maps Dangl.AVA projects along with additional required information to create invoices */
|
|
4935
6628
|
export declare class AvaProjectWrapper implements IAvaProjectWrapper {
|
|
@@ -4945,6 +6638,10 @@ export declare class AvaProjectWrapper implements IAvaProjectWrapper {
|
|
|
4945
6638
|
paymentInstructions?: PaymentInstructions | undefined;
|
|
4946
6639
|
/** The type of the invoice */
|
|
4947
6640
|
invoiceType: InvoiceType;
|
|
6641
|
+
/** If this is set to true, the invoice will be marked as a reverse charge invoice
|
|
6642
|
+
in all VAT rates. You still need to ensure that the actual tax rates are set
|
|
6643
|
+
to zero in all elements */
|
|
6644
|
+
isEuReverseChargeInvoice: boolean;
|
|
4948
6645
|
/** Until when the payment is due */
|
|
4949
6646
|
paymentDueDate?: Date | undefined;
|
|
4950
6647
|
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
@@ -4957,10 +6654,26 @@ are already paid and this will be deducted from the to be paid amount. */
|
|
|
4957
6654
|
alreadyPaidTotalGross: number;
|
|
4958
6655
|
/** An object holding reference used in this invoice */
|
|
4959
6656
|
references?: References | undefined;
|
|
6657
|
+
/** Optional document level allowances. For example, those can be used to supply
|
|
6658
|
+
global discounts e.g. for security deposits. When using this property, please
|
|
6659
|
+
pay attention that a deduction factor on the exported ServiceSpecification
|
|
6660
|
+
will also be exported as an allowance, in this case the total price of the
|
|
6661
|
+
invoice might be different from the total price of the ServiceSpecification. */
|
|
6662
|
+
allowances?: InvoiceAllowance[] | undefined;
|
|
6663
|
+
/** Optional document level charges, e.g. for shipping or handling. When using this property,
|
|
6664
|
+
please pay attention that the charges given here will be applied to the already calculated
|
|
6665
|
+
total price of the ServiceSpecification, in this case the total price of the invoice
|
|
6666
|
+
might be different from the total price of the ServiceSpecification. */
|
|
6667
|
+
charges?: InvoiceCharge[] | undefined;
|
|
6668
|
+
/** Information about the delivery
|
|
6669
|
+
BG-13 in XRechnung */
|
|
6670
|
+
deliveryInformation?: DeliveryInformation | undefined;
|
|
6671
|
+
/** Information about the sellers tax representative. BG-11 in XRechnung */
|
|
6672
|
+
sellerTaxRepresentative?: Organization | undefined;
|
|
4960
6673
|
constructor(data?: IAvaProjectWrapper);
|
|
4961
|
-
init(_data?: any): void;
|
|
6674
|
+
init?(_data?: any): void;
|
|
4962
6675
|
static fromJS(data: any): AvaProjectWrapper;
|
|
4963
|
-
toJSON(data?: any): any;
|
|
6676
|
+
toJSON?(data?: any): any;
|
|
4964
6677
|
}
|
|
4965
6678
|
/** This is a wrapper class that maps Dangl.AVA projects along with additional required information to create invoices */
|
|
4966
6679
|
export interface IAvaProjectWrapper {
|
|
@@ -4976,6 +6689,10 @@ export interface IAvaProjectWrapper {
|
|
|
4976
6689
|
paymentInstructions?: IPaymentInstructions | undefined;
|
|
4977
6690
|
/** The type of the invoice */
|
|
4978
6691
|
invoiceType: InvoiceType;
|
|
6692
|
+
/** If this is set to true, the invoice will be marked as a reverse charge invoice
|
|
6693
|
+
in all VAT rates. You still need to ensure that the actual tax rates are set
|
|
6694
|
+
to zero in all elements */
|
|
6695
|
+
isEuReverseChargeInvoice: boolean;
|
|
4979
6696
|
/** Until when the payment is due */
|
|
4980
6697
|
paymentDueDate?: Date | undefined;
|
|
4981
6698
|
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
@@ -4988,15 +6705,55 @@ are already paid and this will be deducted from the to be paid amount. */
|
|
|
4988
6705
|
alreadyPaidTotalGross: number;
|
|
4989
6706
|
/** An object holding reference used in this invoice */
|
|
4990
6707
|
references?: IReferences | undefined;
|
|
6708
|
+
/** Optional document level allowances. For example, those can be used to supply
|
|
6709
|
+
global discounts e.g. for security deposits. When using this property, please
|
|
6710
|
+
pay attention that a deduction factor on the exported ServiceSpecification
|
|
6711
|
+
will also be exported as an allowance, in this case the total price of the
|
|
6712
|
+
invoice might be different from the total price of the ServiceSpecification. */
|
|
6713
|
+
allowances?: IInvoiceAllowance[] | undefined;
|
|
6714
|
+
/** Optional document level charges, e.g. for shipping or handling. When using this property,
|
|
6715
|
+
please pay attention that the charges given here will be applied to the already calculated
|
|
6716
|
+
total price of the ServiceSpecification, in this case the total price of the invoice
|
|
6717
|
+
might be different from the total price of the ServiceSpecification. */
|
|
6718
|
+
charges?: IInvoiceCharge[] | undefined;
|
|
6719
|
+
/** Information about the delivery
|
|
6720
|
+
BG-13 in XRechnung */
|
|
6721
|
+
deliveryInformation?: IDeliveryInformation | undefined;
|
|
6722
|
+
/** Information about the sellers tax representative. BG-11 in XRechnung */
|
|
6723
|
+
sellerTaxRepresentative?: IOrganization | undefined;
|
|
6724
|
+
}
|
|
6725
|
+
/** The target format for the XRechnung export */
|
|
6726
|
+
export declare enum DestinationXRechnungFormat {
|
|
6727
|
+
Ubl = "Ubl",
|
|
6728
|
+
CrossIndustryInvoice = "CrossIndustryInvoice",
|
|
6729
|
+
FacturX = "FacturX"
|
|
6730
|
+
}
|
|
6731
|
+
/** This model is a wrapper for both an invoice and a PDF file as Base64 string */
|
|
6732
|
+
export declare class PostXRechnungPdfEmbedd implements IPostXRechnungPdfEmbedd {
|
|
6733
|
+
/** The invoice to be embedded into the PDF file */
|
|
6734
|
+
invoice: Invoice;
|
|
6735
|
+
/** The PDF file as Base64 string */
|
|
6736
|
+
pdfFileBase64: string;
|
|
6737
|
+
constructor(data?: IPostXRechnungPdfEmbedd);
|
|
6738
|
+
init?(_data?: any): void;
|
|
6739
|
+
static fromJS(data: any): PostXRechnungPdfEmbedd;
|
|
6740
|
+
toJSON?(data?: any): any;
|
|
6741
|
+
}
|
|
6742
|
+
/** This model is a wrapper for both an invoice and a PDF file as Base64 string */
|
|
6743
|
+
export interface IPostXRechnungPdfEmbedd {
|
|
6744
|
+
/** The invoice to be embedded into the PDF file */
|
|
6745
|
+
invoice: IInvoice;
|
|
6746
|
+
/** The PDF file as Base64 string */
|
|
6747
|
+
pdfFileBase64: string;
|
|
4991
6748
|
}
|
|
4992
6749
|
export declare class LoginPost implements ILoginPost {
|
|
4993
6750
|
identifier: string;
|
|
4994
6751
|
password: string;
|
|
4995
6752
|
staySignedIn: boolean;
|
|
4996
6753
|
constructor(data?: ILoginPost);
|
|
4997
|
-
init(_data?: any): void;
|
|
6754
|
+
init?(_data?: any): void;
|
|
4998
6755
|
static fromJS(data: any): LoginPost;
|
|
4999
|
-
toJSON(data?: any): any;
|
|
6756
|
+
toJSON?(data?: any): any;
|
|
5000
6757
|
}
|
|
5001
6758
|
export interface ILoginPost {
|
|
5002
6759
|
identifier: string;
|
|
@@ -5016,9 +6773,9 @@ export declare class TokenResponseGet implements ITokenResponseGet {
|
|
|
5016
6773
|
tokenType?: string | undefined;
|
|
5017
6774
|
errorType: ResponseErrorType;
|
|
5018
6775
|
constructor(data?: ITokenResponseGet);
|
|
5019
|
-
init(_data?: any): void;
|
|
6776
|
+
init?(_data?: any): void;
|
|
5020
6777
|
static fromJS(data: any): TokenResponseGet;
|
|
5021
|
-
toJSON(data?: any): any;
|
|
6778
|
+
toJSON?(data?: any): any;
|
|
5022
6779
|
}
|
|
5023
6780
|
export interface ITokenResponseGet {
|
|
5024
6781
|
accessToken?: string | undefined;
|
|
@@ -5107,9 +6864,9 @@ export declare class TokenLoginPost implements ITokenLoginPost {
|
|
|
5107
6864
|
identifier: string;
|
|
5108
6865
|
password: string;
|
|
5109
6866
|
constructor(data?: ITokenLoginPost);
|
|
5110
|
-
init(_data?: any): void;
|
|
6867
|
+
init?(_data?: any): void;
|
|
5111
6868
|
static fromJS(data: any): TokenLoginPost;
|
|
5112
|
-
toJSON(data?: any): any;
|
|
6869
|
+
toJSON?(data?: any): any;
|
|
5113
6870
|
}
|
|
5114
6871
|
export interface ITokenLoginPost {
|
|
5115
6872
|
identifier: string;
|
|
@@ -5118,9 +6875,9 @@ export interface ITokenLoginPost {
|
|
|
5118
6875
|
export declare class TokenRefreshPost implements ITokenRefreshPost {
|
|
5119
6876
|
refreshToken: string;
|
|
5120
6877
|
constructor(data?: ITokenRefreshPost);
|
|
5121
|
-
init(_data?: any): void;
|
|
6878
|
+
init?(_data?: any): void;
|
|
5122
6879
|
static fromJS(data: any): TokenRefreshPost;
|
|
5123
|
-
toJSON(data?: any): any;
|
|
6880
|
+
toJSON?(data?: any): any;
|
|
5124
6881
|
}
|
|
5125
6882
|
export interface ITokenRefreshPost {
|
|
5126
6883
|
refreshToken: string;
|
|
@@ -5132,9 +6889,9 @@ export declare class RegisterPost implements IRegisterPost {
|
|
|
5132
6889
|
preferredLanguages?: string[] | undefined;
|
|
5133
6890
|
serviceLoginRedirectUri?: string | undefined;
|
|
5134
6891
|
constructor(data?: IRegisterPost);
|
|
5135
|
-
init(_data?: any): void;
|
|
6892
|
+
init?(_data?: any): void;
|
|
5136
6893
|
static fromJS(data: any): RegisterPost;
|
|
5137
|
-
toJSON(data?: any): any;
|
|
6894
|
+
toJSON?(data?: any): any;
|
|
5138
6895
|
}
|
|
5139
6896
|
export interface IRegisterPost {
|
|
5140
6897
|
username: string;
|
|
@@ -5148,9 +6905,9 @@ export declare class ForgotPasswordPost implements IForgotPasswordPost {
|
|
|
5148
6905
|
preferredLanguages?: string[] | undefined;
|
|
5149
6906
|
serviceLoginRedirectUri?: string | undefined;
|
|
5150
6907
|
constructor(data?: IForgotPasswordPost);
|
|
5151
|
-
init(_data?: any): void;
|
|
6908
|
+
init?(_data?: any): void;
|
|
5152
6909
|
static fromJS(data: any): ForgotPasswordPost;
|
|
5153
|
-
toJSON(data?: any): any;
|
|
6910
|
+
toJSON?(data?: any): any;
|
|
5154
6911
|
}
|
|
5155
6912
|
export interface IForgotPasswordPost {
|
|
5156
6913
|
identifier: string;
|
|
@@ -5168,9 +6925,9 @@ export declare class UserInfoGet implements IUserInfoGet {
|
|
|
5168
6925
|
userClaims?: ClaimGet[] | undefined;
|
|
5169
6926
|
clientClaims?: ClaimGet[] | undefined;
|
|
5170
6927
|
constructor(data?: IUserInfoGet);
|
|
5171
|
-
init(_data?: any): void;
|
|
6928
|
+
init?(_data?: any): void;
|
|
5172
6929
|
static fromJS(data: any): UserInfoGet;
|
|
5173
|
-
toJSON(data?: any): any;
|
|
6930
|
+
toJSON?(data?: any): any;
|
|
5174
6931
|
}
|
|
5175
6932
|
export interface IUserInfoGet {
|
|
5176
6933
|
userIsAuthenticated: boolean;
|
|
@@ -5188,9 +6945,9 @@ export declare class ClaimGet implements IClaimGet {
|
|
|
5188
6945
|
type?: string | undefined;
|
|
5189
6946
|
value?: string | undefined;
|
|
5190
6947
|
constructor(data?: IClaimGet);
|
|
5191
|
-
init(_data?: any): void;
|
|
6948
|
+
init?(_data?: any): void;
|
|
5192
6949
|
static fromJS(data: any): ClaimGet;
|
|
5193
|
-
toJSON(data?: any): any;
|
|
6950
|
+
toJSON?(data?: any): any;
|
|
5194
6951
|
}
|
|
5195
6952
|
export interface IClaimGet {
|
|
5196
6953
|
issuer?: string | undefined;
|