@dangl/avacloud-client-node 1.60.5-avacloud-preview → 1.60.6-avacloud-preview

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/api.d.ts +598 -280
  2. package/api.js +57 -1
  3. package/api.js.map +1 -1
  4. package/api.ts +651 -280
  5. package/package.json +1 -1
package/api.ts CHANGED
@@ -10158,6 +10158,8 @@ export class OenormNoteTextPropertiesDto implements IOenormNoteTextPropertiesDto
10158
10158
  originCode!: OenormOriginCodeDto;
10159
10159
  /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
10160
10160
  openingTextIsFreeText!: boolean;
10161
+ /** 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 */
10162
+ isUndividedPosition!: boolean;
10161
10163
 
10162
10164
  constructor(data?: IOenormNoteTextPropertiesDto) {
10163
10165
  if (data) {
@@ -10172,6 +10174,7 @@ export class OenormNoteTextPropertiesDto implements IOenormNoteTextPropertiesDto
10172
10174
  if (_data) {
10173
10175
  this.originCode = _data["originCode"];
10174
10176
  this.openingTextIsFreeText = _data["openingTextIsFreeText"];
10177
+ this.isUndividedPosition = _data["isUndividedPosition"];
10175
10178
  }
10176
10179
  }
10177
10180
 
@@ -10186,6 +10189,7 @@ export class OenormNoteTextPropertiesDto implements IOenormNoteTextPropertiesDto
10186
10189
  data = typeof data === 'object' ? data : {};
10187
10190
  data["originCode"] = this.originCode;
10188
10191
  data["openingTextIsFreeText"] = this.openingTextIsFreeText;
10192
+ data["isUndividedPosition"] = this.isUndividedPosition;
10189
10193
  return data;
10190
10194
  }
10191
10195
  }
@@ -10196,6 +10200,8 @@ export interface IOenormNoteTextPropertiesDto {
10196
10200
  originCode: OenormOriginCodeDto;
10197
10201
  /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
10198
10202
  openingTextIsFreeText: boolean;
10203
+ /** 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 */
10204
+ isUndividedPosition: boolean;
10199
10205
  }
10200
10206
 
10201
10207
  /** This is a grouping IElement that holds other IElements within. */
@@ -11979,8 +11985,13 @@ Until when the payment is due */
11979
11985
  paymentDueDate?: Date | undefined;
11980
11986
  /** An object holding reference used in this invoice */
11981
11987
  references?: References | undefined;
11982
- /** A text description of payment terms, e.g. cash discounts or payment conditions */
11988
+ /** BT-20
11989
+ A text description of payment terms, e.g. cash discounts or payment conditions */
11983
11990
  paymentTerms?: string | undefined;
11991
+ /** If the PaymentTerms are present and in a correct format, this read-only property
11992
+ can be used to get the actual parsed payment terms in a deserialized and structured format. This will
11993
+ be null if PaymentTerms are not present or not in the correct format */
11994
+ parsedPaymentTerms?: PaymentTerm[] | undefined;
11984
11995
  /** BG-3
11985
11996
  In case of partial or final invoices, it's possible to reference the previous invoice numbers */
11986
11997
  previousInvoices?: PreviousInvoice[] | undefined;
@@ -11996,27 +12007,36 @@ Information about the sellers tax representative */
11996
12007
  /** BG-10
11997
12008
  A payee is someone who receives the payment that is different from the seller */
11998
12009
  payee?: Payee | undefined;
11999
- /** If present, this is an unstructured text that can be used to give additional information
12010
+ /** BG-1
12011
+ If present, this is an unstructured text that can be used to give additional information
12000
12012
  about the invoice. Field BG-1 */
12001
12013
  invoiceNotes?: InvoiceNote[] | undefined;
12002
- /** The period during which the services or goods were delivered */
12014
+ /** BG-14
12015
+ The period during which the services or goods were delivered */
12003
12016
  invoicePeriod?: InvoicePeriod | undefined;
12004
- /** Information about the delivery
12017
+ /** BG-13
12018
+ Information about the delivery
12005
12019
  BG-13 in XRechnung */
12006
12020
  deliveryInformation?: DeliveryInformation | undefined;
12007
- /** Totals for the invoice */
12021
+ /** BG-22
12022
+ Totals for the invoice */
12008
12023
  totals?: InvoiceTotals | undefined;
12009
12024
  /** Instructions how to perform the payment */
12010
12025
  paymentInstructions?: PaymentInstructions | undefined;
12011
- /** Attached documents to the invoice */
12026
+ /** BG-24
12027
+ Attached documents to the invoice */
12012
12028
  documents?: SupportingDocument[] | undefined;
12013
- /** This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
12029
+ /** BG-23
12030
+ This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
12014
12031
  vatBreakdown?: VatBreakdown[] | undefined;
12015
- /** Allowances / deductions on the invoice */
12032
+ /** BG-20
12033
+ Allowances / deductions on the invoice */
12016
12034
  allowances?: InvoiceAllowance[] | undefined;
12017
- /** Charges / additional costs on the invoice */
12035
+ /** BG-21
12036
+ Charges / additional costs on the invoice */
12018
12037
  charges?: InvoiceCharge[] | undefined;
12019
- /** Single line items in the invoice */
12038
+ /** BG-25
12039
+ Single line items in the invoice */
12020
12040
  lineItems?: InvoiceLineItem[] | undefined;
12021
12041
  /** The source type from which the invoice was created */
12022
12042
  sourceType!: SourceType;
@@ -12028,6 +12048,13 @@ BG-13 in XRechnung */
12028
12048
  (<any>this)[property] = (<any>data)[property];
12029
12049
  }
12030
12050
  this.references = data.references && !(<any>data.references).toJSON ? new References(data.references) : <References>this.references;
12051
+ if (data.parsedPaymentTerms) {
12052
+ this.parsedPaymentTerms = [];
12053
+ for (let i = 0; i < data.parsedPaymentTerms.length; i++) {
12054
+ let item = data.parsedPaymentTerms[i];
12055
+ this.parsedPaymentTerms[i] = item && !(<any>item).toJSON ? new PaymentTerm(item) : <PaymentTerm>item;
12056
+ }
12057
+ }
12031
12058
  if (data.previousInvoices) {
12032
12059
  this.previousInvoices = [];
12033
12060
  for (let i = 0; i < data.previousInvoices.length; i++) {
@@ -12097,6 +12124,11 @@ BG-13 in XRechnung */
12097
12124
  this.paymentDueDate = _data["paymentDueDate"] ? new Date(_data["paymentDueDate"].toString()) : <any>undefined;
12098
12125
  this.references = _data["references"] ? References.fromJS(_data["references"]) : <any>undefined;
12099
12126
  this.paymentTerms = _data["paymentTerms"];
12127
+ if (Array.isArray(_data["parsedPaymentTerms"])) {
12128
+ this.parsedPaymentTerms = [] as any;
12129
+ for (let item of _data["parsedPaymentTerms"])
12130
+ this.parsedPaymentTerms!.push(PaymentTerm.fromJS(item));
12131
+ }
12100
12132
  if (Array.isArray(_data["previousInvoices"])) {
12101
12133
  this.previousInvoices = [] as any;
12102
12134
  for (let item of _data["previousInvoices"])
@@ -12168,6 +12200,15 @@ BG-13 in XRechnung */
12168
12200
  data["references"] = <any>undefined;
12169
12201
  }
12170
12202
  data["paymentTerms"] = this.paymentTerms;
12203
+ if (Array.isArray(this.parsedPaymentTerms)) {
12204
+ data["parsedPaymentTerms"] = [];
12205
+ for (let item of this.parsedPaymentTerms)
12206
+ if (typeof item.toJSON !== "undefined") {
12207
+ data["parsedPaymentTerms"].push(item.toJSON());
12208
+ } else {
12209
+ data["parsedPaymentTerms"].push(item);
12210
+ }
12211
+ }
12171
12212
  if (Array.isArray(this.previousInvoices)) {
12172
12213
  data["previousInvoices"] = [];
12173
12214
  for (let item of this.previousInvoices)
@@ -12327,8 +12368,13 @@ Until when the payment is due */
12327
12368
  paymentDueDate?: Date | undefined;
12328
12369
  /** An object holding reference used in this invoice */
12329
12370
  references?: IReferences | undefined;
12330
- /** A text description of payment terms, e.g. cash discounts or payment conditions */
12371
+ /** BT-20
12372
+ A text description of payment terms, e.g. cash discounts or payment conditions */
12331
12373
  paymentTerms?: string | undefined;
12374
+ /** If the PaymentTerms are present and in a correct format, this read-only property
12375
+ can be used to get the actual parsed payment terms in a deserialized and structured format. This will
12376
+ be null if PaymentTerms are not present or not in the correct format */
12377
+ parsedPaymentTerms?: IPaymentTerm[] | undefined;
12332
12378
  /** BG-3
12333
12379
  In case of partial or final invoices, it's possible to reference the previous invoice numbers */
12334
12380
  previousInvoices?: IPreviousInvoice[] | undefined;
@@ -12344,27 +12390,36 @@ Information about the sellers tax representative */
12344
12390
  /** BG-10
12345
12391
  A payee is someone who receives the payment that is different from the seller */
12346
12392
  payee?: IPayee | undefined;
12347
- /** If present, this is an unstructured text that can be used to give additional information
12393
+ /** BG-1
12394
+ If present, this is an unstructured text that can be used to give additional information
12348
12395
  about the invoice. Field BG-1 */
12349
12396
  invoiceNotes?: IInvoiceNote[] | undefined;
12350
- /** The period during which the services or goods were delivered */
12397
+ /** BG-14
12398
+ The period during which the services or goods were delivered */
12351
12399
  invoicePeriod?: IInvoicePeriod | undefined;
12352
- /** Information about the delivery
12400
+ /** BG-13
12401
+ Information about the delivery
12353
12402
  BG-13 in XRechnung */
12354
12403
  deliveryInformation?: IDeliveryInformation | undefined;
12355
- /** Totals for the invoice */
12404
+ /** BG-22
12405
+ Totals for the invoice */
12356
12406
  totals?: IInvoiceTotals | undefined;
12357
12407
  /** Instructions how to perform the payment */
12358
12408
  paymentInstructions?: IPaymentInstructions | undefined;
12359
- /** Attached documents to the invoice */
12409
+ /** BG-24
12410
+ Attached documents to the invoice */
12360
12411
  documents?: ISupportingDocument[] | undefined;
12361
- /** This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
12412
+ /** BG-23
12413
+ This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
12362
12414
  vatBreakdown?: IVatBreakdown[] | undefined;
12363
- /** Allowances / deductions on the invoice */
12415
+ /** BG-20
12416
+ Allowances / deductions on the invoice */
12364
12417
  allowances?: IInvoiceAllowance[] | undefined;
12365
- /** Charges / additional costs on the invoice */
12418
+ /** BG-21
12419
+ Charges / additional costs on the invoice */
12366
12420
  charges?: IInvoiceCharge[] | undefined;
12367
- /** Single line items in the invoice */
12421
+ /** BG-25
12422
+ Single line items in the invoice */
12368
12423
  lineItems?: IInvoiceLineItem[] | undefined;
12369
12424
  /** The source type from which the invoice was created */
12370
12425
  sourceType: SourceType;
@@ -12384,36 +12439,46 @@ export enum InvoiceType {
12384
12439
 
12385
12440
  /** This class holds typical references used in an invoice */
12386
12441
  export class References implements IReferences {
12387
- /** An internal reference used by the buyer, this can also be used as the
12442
+ /** BT-10
12443
+ An internal reference used by the buyer, this can also be used as the
12388
12444
  'Leitweg-ID' in Germany
12389
12445
  BT-10 in XRechnung. */
12390
12446
  buyerReference?: string | undefined;
12391
- /** Reference to a project
12447
+ /** BT-11
12448
+ Reference to a project
12392
12449
  BT-11 in XRechnung. */
12393
12450
  projectReference?: string | undefined;
12394
- /** Reference to a contract
12451
+ /** BT-12
12452
+ Reference to a contract
12395
12453
  BT-12 in XRechnung. */
12396
12454
  contractReference?: string | undefined;
12397
- /** Reference to a purchase order created by the buyer
12455
+ /** BT-13
12456
+ Reference to a purchase order created by the buyer
12398
12457
  BT-13 in XRechnung. */
12399
12458
  purchaseOrderReference?: string | undefined;
12400
- /** Reference to a sales order created by the seller
12459
+ /** BT-14
12460
+ Reference to a sales order created by the seller
12401
12461
  BT-14 in XRechnung. */
12402
12462
  salesOrderReference?: string | undefined;
12403
- /** Reference to a delivery note
12463
+ /** BT-15
12464
+ Reference to a delivery note
12404
12465
  BT-15 in XRechnung. */
12405
12466
  receivingAdviceReference?: string | undefined;
12406
- /** Reference to a dispatch advice
12467
+ /** BT-16
12468
+ Reference to a dispatch advice
12407
12469
  BT-16 in XRechnung. */
12408
12470
  dispatchAdviceReference?: string | undefined;
12409
- /** Reference to a tender or lot
12471
+ /** BT-17
12472
+ Reference to a tender or lot
12410
12473
  BT-17 in XRechnung. */
12411
12474
  tenderOrLotReference?: string | undefined;
12412
- /** Reference to a custom item, e.g. a phone number, person,
12475
+ /** BT-18
12476
+ Reference to a custom item, e.g. a phone number, person,
12413
12477
  contract or anything that would identify the invoice in the buyer's system
12414
12478
  BT-18 in XRechnung. */
12415
12479
  invoicedObjectIdentifier?: string | undefined;
12416
- /** This is a reference for accounting, like a cost center or similar. In German,
12480
+ /** BT-19
12481
+ This is a reference for accounting, like a cost center or similar. In German,
12417
12482
  this would be a "Kostenstelle".
12418
12483
  BT-19 in XRechnung. */
12419
12484
  accountingReference?: string | undefined;
@@ -12467,41 +12532,103 @@ BT-19 in XRechnung. */
12467
12532
 
12468
12533
  /** This class holds typical references used in an invoice */
12469
12534
  export interface IReferences {
12470
- /** An internal reference used by the buyer, this can also be used as the
12535
+ /** BT-10
12536
+ An internal reference used by the buyer, this can also be used as the
12471
12537
  'Leitweg-ID' in Germany
12472
12538
  BT-10 in XRechnung. */
12473
12539
  buyerReference?: string | undefined;
12474
- /** Reference to a project
12540
+ /** BT-11
12541
+ Reference to a project
12475
12542
  BT-11 in XRechnung. */
12476
12543
  projectReference?: string | undefined;
12477
- /** Reference to a contract
12544
+ /** BT-12
12545
+ Reference to a contract
12478
12546
  BT-12 in XRechnung. */
12479
12547
  contractReference?: string | undefined;
12480
- /** Reference to a purchase order created by the buyer
12548
+ /** BT-13
12549
+ Reference to a purchase order created by the buyer
12481
12550
  BT-13 in XRechnung. */
12482
12551
  purchaseOrderReference?: string | undefined;
12483
- /** Reference to a sales order created by the seller
12552
+ /** BT-14
12553
+ Reference to a sales order created by the seller
12484
12554
  BT-14 in XRechnung. */
12485
12555
  salesOrderReference?: string | undefined;
12486
- /** Reference to a delivery note
12556
+ /** BT-15
12557
+ Reference to a delivery note
12487
12558
  BT-15 in XRechnung. */
12488
12559
  receivingAdviceReference?: string | undefined;
12489
- /** Reference to a dispatch advice
12560
+ /** BT-16
12561
+ Reference to a dispatch advice
12490
12562
  BT-16 in XRechnung. */
12491
12563
  dispatchAdviceReference?: string | undefined;
12492
- /** Reference to a tender or lot
12564
+ /** BT-17
12565
+ Reference to a tender or lot
12493
12566
  BT-17 in XRechnung. */
12494
12567
  tenderOrLotReference?: string | undefined;
12495
- /** Reference to a custom item, e.g. a phone number, person,
12568
+ /** BT-18
12569
+ Reference to a custom item, e.g. a phone number, person,
12496
12570
  contract or anything that would identify the invoice in the buyer's system
12497
12571
  BT-18 in XRechnung. */
12498
12572
  invoicedObjectIdentifier?: string | undefined;
12499
- /** This is a reference for accounting, like a cost center or similar. In German,
12573
+ /** BT-19
12574
+ This is a reference for accounting, like a cost center or similar. In German,
12500
12575
  this would be a "Kostenstelle".
12501
12576
  BT-19 in XRechnung. */
12502
12577
  accountingReference?: string | undefined;
12503
12578
  }
12504
12579
 
12580
+ /** Represents a discount with a number of days, percentage, and an optional base amount. */
12581
+ export class PaymentTerm implements IPaymentTerm {
12582
+ /** The number of days until the discount is valid. */
12583
+ days!: number;
12584
+ /** The percentage of the discount. */
12585
+ percent!: number;
12586
+ /** The base amount for the discount, if applicable. */
12587
+ baseAmount?: number | undefined;
12588
+
12589
+ constructor(data?: IPaymentTerm) {
12590
+ if (data) {
12591
+ for (var property in data) {
12592
+ if (data.hasOwnProperty(property))
12593
+ (<any>this)[property] = (<any>data)[property];
12594
+ }
12595
+ }
12596
+ }
12597
+
12598
+ init?(_data?: any) {
12599
+ if (_data) {
12600
+ this.days = _data["days"];
12601
+ this.percent = _data["percent"];
12602
+ this.baseAmount = _data["baseAmount"];
12603
+ }
12604
+ }
12605
+
12606
+ static fromJS(data: any): PaymentTerm {
12607
+ data = typeof data === 'object' ? data : {};
12608
+ let result = new PaymentTerm();
12609
+ result.init!(data);
12610
+ return result;
12611
+ }
12612
+
12613
+ toJSON?(data?: any) {
12614
+ data = typeof data === 'object' ? data : {};
12615
+ data["days"] = this.days;
12616
+ data["percent"] = this.percent;
12617
+ data["baseAmount"] = this.baseAmount;
12618
+ return data;
12619
+ }
12620
+ }
12621
+
12622
+ /** Represents a discount with a number of days, percentage, and an optional base amount. */
12623
+ export interface IPaymentTerm {
12624
+ /** The number of days until the discount is valid. */
12625
+ days: number;
12626
+ /** The percentage of the discount. */
12627
+ percent: number;
12628
+ /** The base amount for the discount, if applicable. */
12629
+ baseAmount?: number | undefined;
12630
+ }
12631
+
12505
12632
  /** References to previous invoices */
12506
12633
  export class PreviousInvoice implements IPreviousInvoice {
12507
12634
  /** BT-26
@@ -12554,35 +12681,52 @@ The number of the previous invoice */
12554
12681
 
12555
12682
  /** Represents an organization, e.g. a buyer or a seller */
12556
12683
  export class Organization implements IOrganization {
12557
- /** The identifier of the organization */
12684
+ /** BT-46 (BT-29 for the Seller)
12685
+ The identifier of the organization */
12558
12686
  identifier?: string | undefined;
12559
- /** The name of the organization */
12687
+ /** BT-44 (BT-27 for the seller, BT-62 for the seller tax representative)
12688
+ The name of the organization */
12560
12689
  name?: string | undefined;
12561
- /** A registration number, e.g. a Handelsregisternummer in Germany */
12690
+ /** BT-30, for the seller, doesn't exist in the buyer actually
12691
+ A registration number, e.g. a Handelsregisternummer in Germany */
12562
12692
  registrationNumber?: string | undefined;
12563
- /** The VAT ID for the organization */
12693
+ /** BT-48, BT-32 for the seller, BT-63 for the seller tax representative
12694
+ The VAT ID for the organization */
12564
12695
  vatId?: string | undefined;
12565
- /** The tax ID for the organization */
12696
+ /** BT-32 for the seller, does not exist for the buyer
12697
+ The tax ID for the organization */
12566
12698
  taxId?: string | undefined;
12567
- /** An email address for the organization */
12699
+ /** BT-49
12700
+ An email address for the organization */
12568
12701
  email?: string | undefined;
12569
- /** The name of a contact person */
12702
+ /** BT-56
12703
+ The name of a contact person */
12570
12704
  contactPersonName?: string | undefined;
12571
- /** The phone of a contact person */
12705
+ /** BT-57
12706
+ The phone of a contact person */
12572
12707
  contactPersonPhone?: string | undefined;
12573
- /** The email of a contact person */
12708
+ /** BT-58
12709
+ The email of a contact person */
12574
12710
  contactPersonEmail?: string | undefined;
12575
- /** The address of the organization */
12711
+ /** BT-50, BT-35 for the seller, BT-64 for the seller tax representative
12712
+ BT-51, BT-36 for the seller, BT-65 for the seller tax representative
12713
+ BT-163, BT-162 for the seller, BT-164 for the seller tax representative
12714
+ The address of the organization */
12576
12715
  address?: string | undefined;
12577
- /** The city of the organization */
12716
+ /** BT-52, BT-37 for the seller, BT-66 for the seller tax representative
12717
+ The city of the organization */
12578
12718
  city?: string | undefined;
12579
- /** The zip code of the organization */
12719
+ /** BT-53, BT-38 for the seller, BT-67 for the seller tax representative
12720
+ The zip code of the organization */
12580
12721
  zipCode?: string | undefined;
12581
- /** The ISO 3166-1 2 letter country code */
12722
+ /** BT-55, BT-40 for the seller, BT-69 for the seller tax representative
12723
+ The ISO 3166-1 2 letter country code */
12582
12724
  countryCode?: string | undefined;
12583
- /** The state of the organization, e.g. a federal state in Germany */
12725
+ /** BT-54, BT-39 for the seller, BT-68 for the seller tax representative
12726
+ The state of the organization, e.g. a federal state in Germany */
12584
12727
  state?: string | undefined;
12585
- /** This provides some additional legal information.
12728
+ /** BT-33
12729
+ This provides some additional legal information.
12586
12730
  BT-33 in XRechnung, and this is only used for the seller. */
12587
12731
  additionalLegalInformation?: string | undefined;
12588
12732
 
@@ -12645,46 +12789,66 @@ BT-33 in XRechnung, and this is only used for the seller. */
12645
12789
 
12646
12790
  /** Represents an organization, e.g. a buyer or a seller */
12647
12791
  export interface IOrganization {
12648
- /** The identifier of the organization */
12792
+ /** BT-46 (BT-29 for the Seller)
12793
+ The identifier of the organization */
12649
12794
  identifier?: string | undefined;
12650
- /** The name of the organization */
12795
+ /** BT-44 (BT-27 for the seller, BT-62 for the seller tax representative)
12796
+ The name of the organization */
12651
12797
  name?: string | undefined;
12652
- /** A registration number, e.g. a Handelsregisternummer in Germany */
12798
+ /** BT-30, for the seller, doesn't exist in the buyer actually
12799
+ A registration number, e.g. a Handelsregisternummer in Germany */
12653
12800
  registrationNumber?: string | undefined;
12654
- /** The VAT ID for the organization */
12801
+ /** BT-48, BT-32 for the seller, BT-63 for the seller tax representative
12802
+ The VAT ID for the organization */
12655
12803
  vatId?: string | undefined;
12656
- /** The tax ID for the organization */
12804
+ /** BT-32 for the seller, does not exist for the buyer
12805
+ The tax ID for the organization */
12657
12806
  taxId?: string | undefined;
12658
- /** An email address for the organization */
12807
+ /** BT-49
12808
+ An email address for the organization */
12659
12809
  email?: string | undefined;
12660
- /** The name of a contact person */
12810
+ /** BT-56
12811
+ The name of a contact person */
12661
12812
  contactPersonName?: string | undefined;
12662
- /** The phone of a contact person */
12813
+ /** BT-57
12814
+ The phone of a contact person */
12663
12815
  contactPersonPhone?: string | undefined;
12664
- /** The email of a contact person */
12816
+ /** BT-58
12817
+ The email of a contact person */
12665
12818
  contactPersonEmail?: string | undefined;
12666
- /** The address of the organization */
12819
+ /** BT-50, BT-35 for the seller, BT-64 for the seller tax representative
12820
+ BT-51, BT-36 for the seller, BT-65 for the seller tax representative
12821
+ BT-163, BT-162 for the seller, BT-164 for the seller tax representative
12822
+ The address of the organization */
12667
12823
  address?: string | undefined;
12668
- /** The city of the organization */
12824
+ /** BT-52, BT-37 for the seller, BT-66 for the seller tax representative
12825
+ The city of the organization */
12669
12826
  city?: string | undefined;
12670
- /** The zip code of the organization */
12827
+ /** BT-53, BT-38 for the seller, BT-67 for the seller tax representative
12828
+ The zip code of the organization */
12671
12829
  zipCode?: string | undefined;
12672
- /** The ISO 3166-1 2 letter country code */
12830
+ /** BT-55, BT-40 for the seller, BT-69 for the seller tax representative
12831
+ The ISO 3166-1 2 letter country code */
12673
12832
  countryCode?: string | undefined;
12674
- /** The state of the organization, e.g. a federal state in Germany */
12833
+ /** BT-54, BT-39 for the seller, BT-68 for the seller tax representative
12834
+ The state of the organization, e.g. a federal state in Germany */
12675
12835
  state?: string | undefined;
12676
- /** This provides some additional legal information.
12836
+ /** BT-33
12837
+ This provides some additional legal information.
12677
12838
  BT-33 in XRechnung, and this is only used for the seller. */
12678
12839
  additionalLegalInformation?: string | undefined;
12679
12840
  }
12680
12841
 
12681
12842
  /** Represents a payee, meaning someone that receives the payment */
12682
12843
  export class Payee implements IPayee {
12683
- /** The name of the payee */
12844
+ /** BT-59
12845
+ The name of the payee */
12684
12846
  name?: string | undefined;
12685
- /** The identifier of the payee */
12847
+ /** BT-60
12848
+ The identifier of the payee */
12686
12849
  identifier?: string | undefined;
12687
- /** A registered identifier for the payee, e.g. a VAT ID
12850
+ /** BT-61
12851
+ A registered identifier for the payee, e.g. a VAT ID
12688
12852
  or Tax ID */
12689
12853
  legalRegistrationIdentifier?: string | undefined;
12690
12854
 
@@ -12723,25 +12887,30 @@ or Tax ID */
12723
12887
 
12724
12888
  /** Represents a payee, meaning someone that receives the payment */
12725
12889
  export interface IPayee {
12726
- /** The name of the payee */
12890
+ /** BT-59
12891
+ The name of the payee */
12727
12892
  name?: string | undefined;
12728
- /** The identifier of the payee */
12893
+ /** BT-60
12894
+ The identifier of the payee */
12729
12895
  identifier?: string | undefined;
12730
- /** A registered identifier for the payee, e.g. a VAT ID
12896
+ /** BT-61
12897
+ A registered identifier for the payee, e.g. a VAT ID
12731
12898
  or Tax ID */
12732
12899
  legalRegistrationIdentifier?: string | undefined;
12733
12900
  }
12734
12901
 
12735
12902
  /** Represents a note / text in an invoice */
12736
12903
  export class InvoiceNote implements IInvoiceNote {
12737
- /** Short summary / heading. Should be a text code from this list:
12904
+ /** BT-21
12905
+ Short summary / heading. Should be a text code from this list:
12738
12906
  https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4451.htm
12739
12907
  Field BT-21 */
12740
12908
  shortText?: string | undefined;
12741
12909
  /** Short summary / heading type. This will be automatically parsed from ShortText
12742
12910
  and is a read-only property. */
12743
12911
  shortTextType?: ShortTextType | undefined;
12744
- /** Explanation of this note
12912
+ /** BT-22
12913
+ Explanation of this note
12745
12914
  Field BT-22 */
12746
12915
  longText?: string | undefined;
12747
12916
 
@@ -12780,14 +12949,16 @@ Field BT-22 */
12780
12949
 
12781
12950
  /** Represents a note / text in an invoice */
12782
12951
  export interface IInvoiceNote {
12783
- /** Short summary / heading. Should be a text code from this list:
12952
+ /** BT-21
12953
+ Short summary / heading. Should be a text code from this list:
12784
12954
  https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4451.htm
12785
12955
  Field BT-21 */
12786
12956
  shortText?: string | undefined;
12787
12957
  /** Short summary / heading type. This will be automatically parsed from ShortText
12788
12958
  and is a read-only property. */
12789
12959
  shortTextType?: ShortTextType | undefined;
12790
- /** Explanation of this note
12960
+ /** BT-22
12961
+ Explanation of this note
12791
12962
  Field BT-22 */
12792
12963
  longText?: string | undefined;
12793
12964
  }
@@ -13177,9 +13348,11 @@ export enum ShortTextType {
13177
13348
 
13178
13349
  /** Represents an invoice period with start and end dates */
13179
13350
  export class InvoicePeriod implements IInvoicePeriod {
13180
- /** The start date */
13351
+ /** BT-134
13352
+ The start date */
13181
13353
  start?: Date | undefined;
13182
- /** The end date */
13354
+ /** BT-135
13355
+ The end date */
13183
13356
  end?: Date | undefined;
13184
13357
 
13185
13358
  constructor(data?: IInvoicePeriod) {
@@ -13215,21 +13388,27 @@ export class InvoicePeriod implements IInvoicePeriod {
13215
13388
 
13216
13389
  /** Represents an invoice period with start and end dates */
13217
13390
  export interface IInvoicePeriod {
13218
- /** The start date */
13391
+ /** BT-134
13392
+ The start date */
13219
13393
  start?: Date | undefined;
13220
- /** The end date */
13394
+ /** BT-135
13395
+ The end date */
13221
13396
  end?: Date | undefined;
13222
13397
  }
13223
13398
 
13224
13399
  /** Information about the delivery */
13225
13400
  export class DeliveryInformation implements IDeliveryInformation {
13226
- /** BT-70 in XRechnung */
13401
+ /** BT-70
13402
+ BT-70 in XRechnung */
13227
13403
  deliverToName?: string | undefined;
13228
- /** BT-71 in XRechnung */
13404
+ /** BT-71
13405
+ BT-71 in XRechnung */
13229
13406
  deliverToLocationIdentifier?: string | undefined;
13230
- /** BT-72 in XRechnung */
13407
+ /** BT-72
13408
+ BT-72 in XRechnung */
13231
13409
  deliveryDate?: Date | undefined;
13232
- /** BG-15 in XRechnung */
13410
+ /** BG-15
13411
+ BG-15 in XRechnung */
13233
13412
  deliveryAddress?: DeliveryAddress | undefined;
13234
13413
 
13235
13414
  constructor(data?: IDeliveryInformation) {
@@ -13278,25 +13457,33 @@ export class DeliveryInformation implements IDeliveryInformation {
13278
13457
 
13279
13458
  /** Information about the delivery */
13280
13459
  export interface IDeliveryInformation {
13281
- /** BT-70 in XRechnung */
13460
+ /** BT-70
13461
+ BT-70 in XRechnung */
13282
13462
  deliverToName?: string | undefined;
13283
- /** BT-71 in XRechnung */
13463
+ /** BT-71
13464
+ BT-71 in XRechnung */
13284
13465
  deliverToLocationIdentifier?: string | undefined;
13285
- /** BT-72 in XRechnung */
13466
+ /** BT-72
13467
+ BT-72 in XRechnung */
13286
13468
  deliveryDate?: Date | undefined;
13287
- /** BG-15 in XRechnung */
13469
+ /** BG-15
13470
+ BG-15 in XRechnung */
13288
13471
  deliveryAddress?: IDeliveryAddress | undefined;
13289
13472
  }
13290
13473
 
13291
13474
  /** Address for deliveries */
13292
13475
  export class DeliveryAddress implements IDeliveryAddress {
13293
- /** The address. BT-75, BT-76 and BT-165 in XRechnung. */
13476
+ /** BT-75, BT-76 and BT-165
13477
+ The address. BT-75, BT-76 and BT-165 in XRechnung. */
13294
13478
  address?: string | undefined;
13295
- /** The city. BT-77 in XRechnung. */
13479
+ /** BT-77
13480
+ The city. BT-77 in XRechnung. */
13296
13481
  city?: string | undefined;
13297
- /** The zip code. BT-78 in XRechnung. */
13482
+ /** BT-78
13483
+ The zip code. BT-78 in XRechnung. */
13298
13484
  zipCode?: string | undefined;
13299
- /** The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
13485
+ /** BT-80
13486
+ The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
13300
13487
  countryCode?: string | undefined;
13301
13488
 
13302
13489
  constructor(data?: IDeliveryAddress) {
@@ -13336,47 +13523,60 @@ export class DeliveryAddress implements IDeliveryAddress {
13336
13523
 
13337
13524
  /** Address for deliveries */
13338
13525
  export interface IDeliveryAddress {
13339
- /** The address. BT-75, BT-76 and BT-165 in XRechnung. */
13526
+ /** BT-75, BT-76 and BT-165
13527
+ The address. BT-75, BT-76 and BT-165 in XRechnung. */
13340
13528
  address?: string | undefined;
13341
- /** The city. BT-77 in XRechnung. */
13529
+ /** BT-77
13530
+ The city. BT-77 in XRechnung. */
13342
13531
  city?: string | undefined;
13343
- /** The zip code. BT-78 in XRechnung. */
13532
+ /** BT-78
13533
+ The zip code. BT-78 in XRechnung. */
13344
13534
  zipCode?: string | undefined;
13345
- /** The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
13535
+ /** BT-80
13536
+ The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
13346
13537
  countryCode?: string | undefined;
13347
13538
  }
13348
13539
 
13349
13540
  /** Totals for the invoice */
13350
13541
  export class InvoiceTotals implements IInvoiceTotals {
13351
- /** Sum of all invoice items in net.
13542
+ /** BT-106
13543
+ Sum of all invoice items in net.
13352
13544
  BT-106 in XRechnung. */
13353
13545
  totalNet?: number | undefined;
13354
- /** This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
13546
+ /** BT-107
13547
+ This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
13355
13548
  BT-107 in XRechnung. */
13356
13549
  totalAllowances?: number | undefined;
13357
- /** This is the sum of all charges in the invoice, except VAT. For example, late
13550
+ /** BT-108
13551
+ This is the sum of all charges in the invoice, except VAT. For example, late
13358
13552
  fees or surcharges.
13359
13553
  BT-108 in XRechnung. */
13360
13554
  totalCharges?: number | undefined;
13361
- /** This is the total net value of the invoice after applied allowances and charges,
13555
+ /** BT-109
13556
+ This is the total net value of the invoice after applied allowances and charges,
13362
13557
  meaning the actual net sum to be paid.
13363
13558
  BT-109 in XRechnung. */
13364
13559
  totalAfterDeductions?: number | undefined;
13365
- /** The total amount of VAT in the invoice.
13560
+ /** BT-110
13561
+ The total amount of VAT in the invoice.
13366
13562
  BT-110 in XRechnung. */
13367
13563
  totalVatAmount?: number | undefined;
13368
- /** The total gross amount of the invoice, including all taxes and deductions.
13564
+ /** BT-112
13565
+ The total gross amount of the invoice, including all taxes and deductions.
13369
13566
  BT-112 in XRechnung. */
13370
13567
  totalGross?: number | undefined;
13371
- /** The total amount that has already been paid for this invoice, e.g. used when
13568
+ /** BT-113
13569
+ The total amount that has already been paid for this invoice, e.g. used when
13372
13570
  previous invoice sums are included here that have already been paid.
13373
13571
  BT-113 in XRechnung. */
13374
13572
  alreadyPaidTotal?: number | undefined;
13375
- /** If this is given, this specifies if any rounding amount is applied to the invoice,
13573
+ /** BT-114
13574
+ If this is given, this specifies if any rounding amount is applied to the invoice,
13376
13575
  before calculating the TotalToBePaid value.
13377
13576
  BT-114 in XRechnung. */
13378
13577
  payableRoundingAmount?: number | undefined;
13379
- /** The sum that needs to be paid for this invoice. This is the total gross amount
13578
+ /** BT-115
13579
+ The sum that needs to be paid for this invoice. This is the total gross amount
13380
13580
  minus the already paid amount.
13381
13581
  BT-115 in XRechnung. */
13382
13582
  totalToBePaid?: number | undefined;
@@ -13428,35 +13628,44 @@ BT-115 in XRechnung. */
13428
13628
 
13429
13629
  /** Totals for the invoice */
13430
13630
  export interface IInvoiceTotals {
13431
- /** Sum of all invoice items in net.
13631
+ /** BT-106
13632
+ Sum of all invoice items in net.
13432
13633
  BT-106 in XRechnung. */
13433
13634
  totalNet?: number | undefined;
13434
- /** This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
13635
+ /** BT-107
13636
+ This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
13435
13637
  BT-107 in XRechnung. */
13436
13638
  totalAllowances?: number | undefined;
13437
- /** This is the sum of all charges in the invoice, except VAT. For example, late
13639
+ /** BT-108
13640
+ This is the sum of all charges in the invoice, except VAT. For example, late
13438
13641
  fees or surcharges.
13439
13642
  BT-108 in XRechnung. */
13440
13643
  totalCharges?: number | undefined;
13441
- /** This is the total net value of the invoice after applied allowances and charges,
13644
+ /** BT-109
13645
+ This is the total net value of the invoice after applied allowances and charges,
13442
13646
  meaning the actual net sum to be paid.
13443
13647
  BT-109 in XRechnung. */
13444
13648
  totalAfterDeductions?: number | undefined;
13445
- /** The total amount of VAT in the invoice.
13649
+ /** BT-110
13650
+ The total amount of VAT in the invoice.
13446
13651
  BT-110 in XRechnung. */
13447
13652
  totalVatAmount?: number | undefined;
13448
- /** The total gross amount of the invoice, including all taxes and deductions.
13653
+ /** BT-112
13654
+ The total gross amount of the invoice, including all taxes and deductions.
13449
13655
  BT-112 in XRechnung. */
13450
13656
  totalGross?: number | undefined;
13451
- /** The total amount that has already been paid for this invoice, e.g. used when
13657
+ /** BT-113
13658
+ The total amount that has already been paid for this invoice, e.g. used when
13452
13659
  previous invoice sums are included here that have already been paid.
13453
13660
  BT-113 in XRechnung. */
13454
13661
  alreadyPaidTotal?: number | undefined;
13455
- /** If this is given, this specifies if any rounding amount is applied to the invoice,
13662
+ /** BT-114
13663
+ If this is given, this specifies if any rounding amount is applied to the invoice,
13456
13664
  before calculating the TotalToBePaid value.
13457
13665
  BT-114 in XRechnung. */
13458
13666
  payableRoundingAmount?: number | undefined;
13459
- /** The sum that needs to be paid for this invoice. This is the total gross amount
13667
+ /** BT-115
13668
+ The sum that needs to be paid for this invoice. This is the total gross amount
13460
13669
  minus the already paid amount.
13461
13670
  BT-115 in XRechnung. */
13462
13671
  totalToBePaid?: number | undefined;
@@ -13464,9 +13673,11 @@ BT-115 in XRechnung. */
13464
13673
 
13465
13674
  /** Instructions how payment for an invoice should be provided. */
13466
13675
  export class PaymentInstructions implements IPaymentInstructions {
13467
- /** Additional text to describe the payment instructions. */
13676
+ /** BT-82
13677
+ Additional text to describe the payment instructions. */
13468
13678
  description?: string | undefined;
13469
- /** This should be a code according to UNCL 4461
13679
+ /** BT-81
13680
+ This should be a code according to UNCL 4461
13470
13681
  to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
13471
13682
  and code "30" means non-SEPA Credit Transfer.
13472
13683
  See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
@@ -13474,11 +13685,13 @@ See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
13474
13685
  /** This should be a type according to UNCL 4461
13475
13686
  to identify the type of payment. */
13476
13687
  paymentType?: PaymentType | undefined;
13477
- /** If a SEPA direct debit payment mean is used, then this reference should be provided.
13688
+ /** BT-90
13689
+ If a SEPA direct debit payment mean is used, then this reference should be provided.
13478
13690
  It's the creditor identifier in SEPA, in German "Gläubiger-Identifikationsnummer".
13479
13691
  Field BT-90 in XRechnung. */
13480
13692
  paymentCreditorIdentifier?: string | undefined;
13481
- /** A list of payment means that can be used to pay the invoice. */
13693
+ /** BG-16
13694
+ A list of payment means that can be used to pay the invoice. */
13482
13695
  paymentMeans?: PaymentMeans[] | undefined;
13483
13696
 
13484
13697
  constructor(data?: IPaymentInstructions) {
@@ -13539,9 +13752,11 @@ Field BT-90 in XRechnung. */
13539
13752
 
13540
13753
  /** Instructions how payment for an invoice should be provided. */
13541
13754
  export interface IPaymentInstructions {
13542
- /** Additional text to describe the payment instructions. */
13755
+ /** BT-82
13756
+ Additional text to describe the payment instructions. */
13543
13757
  description?: string | undefined;
13544
- /** This should be a code according to UNCL 4461
13758
+ /** BT-81
13759
+ This should be a code according to UNCL 4461
13545
13760
  to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
13546
13761
  and code "30" means non-SEPA Credit Transfer.
13547
13762
  See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
@@ -13549,11 +13764,13 @@ See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
13549
13764
  /** This should be a type according to UNCL 4461
13550
13765
  to identify the type of payment. */
13551
13766
  paymentType?: PaymentType | undefined;
13552
- /** If a SEPA direct debit payment mean is used, then this reference should be provided.
13767
+ /** BT-90
13768
+ If a SEPA direct debit payment mean is used, then this reference should be provided.
13553
13769
  It's the creditor identifier in SEPA, in German "Gläubiger-Identifikationsnummer".
13554
13770
  Field BT-90 in XRechnung. */
13555
13771
  paymentCreditorIdentifier?: string | undefined;
13556
- /** A list of payment means that can be used to pay the invoice. */
13772
+ /** BG-16
13773
+ A list of payment means that can be used to pay the invoice. */
13557
13774
  paymentMeans?: IPaymentMeans[] | undefined;
13558
13775
  }
13559
13776
 
@@ -13646,31 +13863,39 @@ export enum PaymentType {
13646
13863
 
13647
13864
  /** Represents a payment means for an invoice */
13648
13865
  export class PaymentMeans implements IPaymentMeans {
13649
- /** This is typically the IBAN or account number
13866
+ /** BT-84
13867
+ This is typically the IBAN or account number
13650
13868
  BT-84 in XRechnung. */
13651
13869
  accountIdentifier?: string | undefined;
13652
- /** The name for the account, typically the name of the owner for
13870
+ /** BT-85
13871
+ The name for the account, typically the name of the owner for
13653
13872
  a bank account.
13654
13873
  BT-85 in XRechnung. */
13655
13874
  accountName?: string | undefined;
13656
- /** This can be the BIC
13875
+ /** BT-86
13876
+ This can be the BIC
13657
13877
  BT-86 in XRechnung. This will be saved in BG-17. */
13658
13878
  serviceProviderIdentifier?: string | undefined;
13659
- /** If used, this is the mandate id for direct debit under which
13879
+ /** BT-89
13880
+ If used, this is the mandate id for direct debit under which
13660
13881
  the direct debit will be performed
13661
13882
  BT-89 in XRechnung. This will be saved in BG-19. */
13662
13883
  directDebitMandateId?: string | undefined;
13663
- /** If used, this is the IBAN for direct debit
13884
+ /** BT-91
13885
+ If used, this is the IBAN for direct debit
13664
13886
  BT-91 in XRechnung. */
13665
13887
  directDebitIban?: string | undefined;
13666
- /** The payment id, e.g. a reference number for the payment. In German,
13888
+ /** BT-83
13889
+ The payment id, e.g. a reference number for the payment. In German,
13667
13890
  this would be called "Verwendungszweck".
13668
13891
  BT-83 in XRechnung. */
13669
13892
  paymentId?: string | undefined;
13670
- /** If this is a card payment, then this is the name of the cardholder.
13893
+ /** BT-88
13894
+ If this is a card payment, then this is the name of the cardholder.
13671
13895
  BT-88 in XRechnung. */
13672
13896
  paymentCardHolderName?: string | undefined;
13673
- /** If this is a card payment, then this is the type of card.
13897
+ /** BT-87
13898
+ If this is a card payment, then this is the type of card.
13674
13899
  BT-87 in XRechnung. This will be saved in BG-18. */
13675
13900
  paymentCardPrimaryAccountNumber?: string | undefined;
13676
13901
  /** If this is a card payment, then this is the type of card.
@@ -13725,31 +13950,39 @@ https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
13725
13950
 
13726
13951
  /** Represents a payment means for an invoice */
13727
13952
  export interface IPaymentMeans {
13728
- /** This is typically the IBAN or account number
13953
+ /** BT-84
13954
+ This is typically the IBAN or account number
13729
13955
  BT-84 in XRechnung. */
13730
13956
  accountIdentifier?: string | undefined;
13731
- /** The name for the account, typically the name of the owner for
13957
+ /** BT-85
13958
+ The name for the account, typically the name of the owner for
13732
13959
  a bank account.
13733
13960
  BT-85 in XRechnung. */
13734
13961
  accountName?: string | undefined;
13735
- /** This can be the BIC
13962
+ /** BT-86
13963
+ This can be the BIC
13736
13964
  BT-86 in XRechnung. This will be saved in BG-17. */
13737
13965
  serviceProviderIdentifier?: string | undefined;
13738
- /** If used, this is the mandate id for direct debit under which
13966
+ /** BT-89
13967
+ If used, this is the mandate id for direct debit under which
13739
13968
  the direct debit will be performed
13740
13969
  BT-89 in XRechnung. This will be saved in BG-19. */
13741
13970
  directDebitMandateId?: string | undefined;
13742
- /** If used, this is the IBAN for direct debit
13971
+ /** BT-91
13972
+ If used, this is the IBAN for direct debit
13743
13973
  BT-91 in XRechnung. */
13744
13974
  directDebitIban?: string | undefined;
13745
- /** The payment id, e.g. a reference number for the payment. In German,
13975
+ /** BT-83
13976
+ The payment id, e.g. a reference number for the payment. In German,
13746
13977
  this would be called "Verwendungszweck".
13747
13978
  BT-83 in XRechnung. */
13748
13979
  paymentId?: string | undefined;
13749
- /** If this is a card payment, then this is the name of the cardholder.
13980
+ /** BT-88
13981
+ If this is a card payment, then this is the name of the cardholder.
13750
13982
  BT-88 in XRechnung. */
13751
13983
  paymentCardHolderName?: string | undefined;
13752
- /** If this is a card payment, then this is the type of card.
13984
+ /** BT-87
13985
+ If this is a card payment, then this is the type of card.
13753
13986
  BT-87 in XRechnung. This will be saved in BG-18. */
13754
13987
  paymentCardPrimaryAccountNumber?: string | undefined;
13755
13988
  /** If this is a card payment, then this is the type of card.
@@ -13760,17 +13993,23 @@ https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
13760
13993
 
13761
13994
  /** Represents a document / attachment that is included with the invoice */
13762
13995
  export class SupportingDocument implements ISupportingDocument {
13763
- /** This is typically an id or a name */
13996
+ /** BT-122
13997
+ This is typically an id or a name */
13764
13998
  documentReference?: string | undefined;
13765
- /** A description of the document */
13999
+ /** BT-123
14000
+ A description of the document */
13766
14001
  description?: string | undefined;
13767
- /** A link to the document in case this is an external reference */
14002
+ /** BT-124
14003
+ A link to the document in case this is an external reference */
13768
14004
  externalDocumentUrl?: string | undefined;
13769
- /** The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
14005
+ /** BT-125
14006
+ The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
13770
14007
  documentBase64?: string | undefined;
13771
- /** This should be present if DocumentBase64 is set. */
14008
+ /** BT-125
14009
+ This should be present if DocumentBase64 is set. */
13772
14010
  fileName?: string | undefined;
13773
- /** The type of the document */
14011
+ /** BT-125
14012
+ The type of the document */
13774
14013
  documentMimeType!: AttachmentMimeType;
13775
14014
  /** 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
13776
14015
  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
@@ -13821,17 +14060,23 @@ the placeholder with the actual Base64 contents of the file in this library, or
13821
14060
 
13822
14061
  /** Represents a document / attachment that is included with the invoice */
13823
14062
  export interface ISupportingDocument {
13824
- /** This is typically an id or a name */
14063
+ /** BT-122
14064
+ This is typically an id or a name */
13825
14065
  documentReference?: string | undefined;
13826
- /** A description of the document */
14066
+ /** BT-123
14067
+ A description of the document */
13827
14068
  description?: string | undefined;
13828
- /** A link to the document in case this is an external reference */
14069
+ /** BT-124
14070
+ A link to the document in case this is an external reference */
13829
14071
  externalDocumentUrl?: string | undefined;
13830
- /** The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
14072
+ /** BT-125
14073
+ The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
13831
14074
  documentBase64?: string | undefined;
13832
- /** This should be present if DocumentBase64 is set. */
14075
+ /** BT-125
14076
+ This should be present if DocumentBase64 is set. */
13833
14077
  fileName?: string | undefined;
13834
- /** The type of the document */
14078
+ /** BT-125
14079
+ The type of the document */
13835
14080
  documentMimeType: AttachmentMimeType;
13836
14081
  /** 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
13837
14082
  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
@@ -13853,20 +14098,26 @@ export enum AttachmentMimeType {
13853
14098
 
13854
14099
  /** Describes the VAT breakdown for an invoice in a single VAT category */
13855
14100
  export class VatBreakdown implements IVatBreakdown {
13856
- /** The total net amount of this VAT category */
14101
+ /** BT-116
14102
+ The total net amount of this VAT category */
13857
14103
  netTaxableAmount?: number | undefined;
13858
- /** The total VAT */
14104
+ /** BT-117
14105
+ The total VAT */
13859
14106
  vatAmount?: number | undefined;
13860
- /** The category of the VAT */
14107
+ /** BT-118
14108
+ The category of the VAT */
13861
14109
  vatCategory!: VatCategory;
13862
- /** The actual tax rate as a decimal value,
14110
+ /** BT-119
14111
+ The actual tax rate as a decimal value,
13863
14112
  e.g. 19% would be 0.19 */
13864
14113
  taxRate?: number | undefined;
13865
- /** If the VAT is exempt, there should be a description here.
14114
+ /** BT-120
14115
+ If the VAT is exempt, there should be a description here.
13866
14116
  For example, in reverse charge scenarios, this text
13867
14117
  should contain a reference to "Reverse charge according to ...". */
13868
14118
  vatExemptionReasonText?: string | undefined;
13869
- /** A code from the VAT exemption reason code list(VATEX)“ */
14119
+ /** BT-121
14120
+ A code from the VAT exemption reason code list(VATEX)“ */
13870
14121
  vatExemptionReasonCode?: string | undefined;
13871
14122
 
13872
14123
  constructor(data?: IVatBreakdown) {
@@ -13910,20 +14161,26 @@ should contain a reference to "Reverse charge according to ...". */
13910
14161
 
13911
14162
  /** Describes the VAT breakdown for an invoice in a single VAT category */
13912
14163
  export interface IVatBreakdown {
13913
- /** The total net amount of this VAT category */
14164
+ /** BT-116
14165
+ The total net amount of this VAT category */
13914
14166
  netTaxableAmount?: number | undefined;
13915
- /** The total VAT */
14167
+ /** BT-117
14168
+ The total VAT */
13916
14169
  vatAmount?: number | undefined;
13917
- /** The category of the VAT */
14170
+ /** BT-118
14171
+ The category of the VAT */
13918
14172
  vatCategory: VatCategory;
13919
- /** The actual tax rate as a decimal value,
14173
+ /** BT-119
14174
+ The actual tax rate as a decimal value,
13920
14175
  e.g. 19% would be 0.19 */
13921
14176
  taxRate?: number | undefined;
13922
- /** If the VAT is exempt, there should be a description here.
14177
+ /** BT-120
14178
+ If the VAT is exempt, there should be a description here.
13923
14179
  For example, in reverse charge scenarios, this text
13924
14180
  should contain a reference to "Reverse charge according to ...". */
13925
14181
  vatExemptionReasonText?: string | undefined;
13926
- /** A code from the VAT exemption reason code list(VATEX)“ */
14182
+ /** BT-121
14183
+ A code from the VAT exemption reason code list(VATEX)“ */
13927
14184
  vatExemptionReasonCode?: string | undefined;
13928
14185
  }
13929
14186
 
@@ -13943,23 +14200,30 @@ export enum VatCategory {
13943
14200
 
13944
14201
  /** This describes an allowance in an invoice, which is a deduction from the total amount */
13945
14202
  export class InvoiceAllowance implements IInvoiceAllowance {
13946
- /** The net amount of the allowance */
14203
+ /** BT-92
14204
+ The net amount of the allowance */
13947
14205
  netAmount?: number | undefined;
13948
- /** If this is a relative / percentage allowance, this should be set
14206
+ /** BT-93
14207
+ If this is a relative / percentage allowance, this should be set
13949
14208
  and give the base amount that is being used for the calculation */
13950
14209
  relativeAllowanceBaseAmount?: number | undefined;
13951
- /** If this is a relative / percentage allowance, this should be set
14210
+ /** BT-94
14211
+ If this is a relative / percentage allowance, this should be set
13952
14212
  and be given in decimal representation, meaning 19% would be 0.19 */
13953
14213
  relativeAllowancePercentage?: number | undefined;
13954
- /** The VAT category for the allowance */
14214
+ /** BT-95
14215
+ The VAT category for the allowance */
13955
14216
  vatCategory!: VatCategory;
13956
- /** The actual tax rate as a decimal value,
14217
+ /** BT-96
14218
+ The actual tax rate as a decimal value,
13957
14219
  meaning 19% would be 0.19 */
13958
14220
  vatRate?: number | undefined;
13959
- /** A description of the allowance. This should not be set it ReasonCode
14221
+ /** BT-97
14222
+ A description of the allowance. This should not be set it ReasonCode
13960
14223
  is provided, otherwise this one takes precedence. */
13961
14224
  reason?: string | undefined;
13962
- /** A reason code for the allowance according to UNTDID 5189.
14225
+ /** BT-98
14226
+ A reason code for the allowance according to UNTDID 5189.
13963
14227
  See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
13964
14228
  reasonCode?: string | undefined;
13965
14229
  /** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
@@ -14011,23 +14275,30 @@ and is a read-only property. */
14011
14275
 
14012
14276
  /** This describes an allowance in an invoice, which is a deduction from the total amount */
14013
14277
  export interface IInvoiceAllowance {
14014
- /** The net amount of the allowance */
14278
+ /** BT-92
14279
+ The net amount of the allowance */
14015
14280
  netAmount?: number | undefined;
14016
- /** If this is a relative / percentage allowance, this should be set
14281
+ /** BT-93
14282
+ If this is a relative / percentage allowance, this should be set
14017
14283
  and give the base amount that is being used for the calculation */
14018
14284
  relativeAllowanceBaseAmount?: number | undefined;
14019
- /** If this is a relative / percentage allowance, this should be set
14285
+ /** BT-94
14286
+ If this is a relative / percentage allowance, this should be set
14020
14287
  and be given in decimal representation, meaning 19% would be 0.19 */
14021
14288
  relativeAllowancePercentage?: number | undefined;
14022
- /** The VAT category for the allowance */
14289
+ /** BT-95
14290
+ The VAT category for the allowance */
14023
14291
  vatCategory: VatCategory;
14024
- /** The actual tax rate as a decimal value,
14292
+ /** BT-96
14293
+ The actual tax rate as a decimal value,
14025
14294
  meaning 19% would be 0.19 */
14026
14295
  vatRate?: number | undefined;
14027
- /** A description of the allowance. This should not be set it ReasonCode
14296
+ /** BT-97
14297
+ A description of the allowance. This should not be set it ReasonCode
14028
14298
  is provided, otherwise this one takes precedence. */
14029
14299
  reason?: string | undefined;
14030
- /** A reason code for the allowance according to UNTDID 5189.
14300
+ /** BT-98
14301
+ A reason code for the allowance according to UNTDID 5189.
14031
14302
  See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
14032
14303
  reasonCode?: string | undefined;
14033
14304
  /** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
@@ -14145,23 +14416,30 @@ export enum AllowanceReasonType {
14145
14416
 
14146
14417
  /** This describes an charge in an invoice, which is a surcharge to the total amount */
14147
14418
  export class InvoiceCharge implements IInvoiceCharge {
14148
- /** The net amount of the charge */
14419
+ /** BT-99
14420
+ The net amount of the charge */
14149
14421
  netAmount?: number | undefined;
14150
- /** If this is a relative / percentage charge, this should be set
14422
+ /** BT-100
14423
+ If this is a relative / percentage charge, this should be set
14151
14424
  and give the base amount that is being used for the calculation */
14152
14425
  relativeChargeBaseAmount?: number | undefined;
14153
- /** If this is a relative / percentage charge, this should be set
14426
+ /** BT-101
14427
+ If this is a relative / percentage charge, this should be set
14154
14428
  and be given in decimal representation, meaning 19% would be 0.19 */
14155
14429
  relativeChargePercentage?: number | undefined;
14156
- /** The VAT category for the charge */
14430
+ /** BT-102
14431
+ The VAT category for the charge */
14157
14432
  vatCategory!: VatCategory;
14158
- /** The actual tax rate as a decimal value,
14433
+ /** BT-103
14434
+ The actual tax rate as a decimal value,
14159
14435
  meaning 19% would be 0.19 */
14160
14436
  vatRate?: number | undefined;
14161
- /** A description of the charge. This should not be set it ReasonCode
14437
+ /** BT-104
14438
+ A description of the charge. This should not be set it ReasonCode
14162
14439
  is provided, otherwise this one takes precedence. */
14163
14440
  reason?: string | undefined;
14164
- /** A reason code for the charge according to UNTDID 7161.
14441
+ /** BT-105
14442
+ A reason code for the charge according to UNTDID 7161.
14165
14443
  See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
14166
14444
  reasonCode?: string | undefined;
14167
14445
  /** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
@@ -14213,23 +14491,30 @@ and is a read-only property. */
14213
14491
 
14214
14492
  /** This describes an charge in an invoice, which is a surcharge to the total amount */
14215
14493
  export interface IInvoiceCharge {
14216
- /** The net amount of the charge */
14494
+ /** BT-99
14495
+ The net amount of the charge */
14217
14496
  netAmount?: number | undefined;
14218
- /** If this is a relative / percentage charge, this should be set
14497
+ /** BT-100
14498
+ If this is a relative / percentage charge, this should be set
14219
14499
  and give the base amount that is being used for the calculation */
14220
14500
  relativeChargeBaseAmount?: number | undefined;
14221
- /** If this is a relative / percentage charge, this should be set
14501
+ /** BT-101
14502
+ If this is a relative / percentage charge, this should be set
14222
14503
  and be given in decimal representation, meaning 19% would be 0.19 */
14223
14504
  relativeChargePercentage?: number | undefined;
14224
- /** The VAT category for the charge */
14505
+ /** BT-102
14506
+ The VAT category for the charge */
14225
14507
  vatCategory: VatCategory;
14226
- /** The actual tax rate as a decimal value,
14508
+ /** BT-103
14509
+ The actual tax rate as a decimal value,
14227
14510
  meaning 19% would be 0.19 */
14228
14511
  vatRate?: number | undefined;
14229
- /** A description of the charge. This should not be set it ReasonCode
14512
+ /** BT-104
14513
+ A description of the charge. This should not be set it ReasonCode
14230
14514
  is provided, otherwise this one takes precedence. */
14231
14515
  reason?: string | undefined;
14232
- /** A reason code for the charge according to UNTDID 7161.
14516
+ /** BT-105
14517
+ A reason code for the charge according to UNTDID 7161.
14233
14518
  See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
14234
14519
  reasonCode?: string | undefined;
14235
14520
  /** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
@@ -14404,39 +14689,53 @@ export enum ChargeReasonType {
14404
14689
 
14405
14690
  /** Represents a single invoice line item */
14406
14691
  export class InvoiceLineItem implements IInvoiceLineItem {
14407
- /** An unique identifier for the line item */
14692
+ /** BT-126
14693
+ An unique identifier for the line item */
14408
14694
  identifier?: string | undefined;
14409
- /** An unstructured note to classify line items */
14695
+ /** BT-127
14696
+ An unstructured note to classify line items */
14410
14697
  note?: string | undefined;
14411
- /** A seller-defined object identifier for this line item,
14698
+ /** BT-128
14699
+ A seller-defined object identifier for this line item,
14412
14700
  meaning an identifier for the actual line. This could be
14413
14701
  a numbering sequence or a reference to a product. */
14414
14702
  objectIdentifier?: string | undefined;
14415
- /** The actual invoiced quantity of the line item */
14703
+ /** BT-129
14704
+ The actual invoiced quantity of the line item */
14416
14705
  quantity?: number | undefined;
14417
- /** A code for the unit of the quantity. This should be a code as defined
14706
+ /** BT-130
14707
+ A code for the unit of the quantity. This should be a code as defined
14418
14708
  in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
14419
14709
  International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
14420
14710
  Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names).
14421
14711
  See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931 */
14422
14712
  unitCode?: string | undefined;
14423
- /** The net amount for this line item. This is the total price for positions */
14713
+ /** BT-131
14714
+ The net amount for this line item. This is the total price for positions */
14424
14715
  netAmount?: number | undefined;
14425
- /** A reference to an item in the buyers purachase order */
14716
+ /** BT-132
14717
+ A reference to an item in the buyers purachase order */
14426
14718
  purchaseOrderReference?: string | undefined;
14427
- /** Information about the invoice period for this line item. */
14719
+ /** BG-26
14720
+ Information about the invoice period for this line item. */
14428
14721
  lineItemPeriod?: InvoicePeriod | undefined;
14429
- /** Allowances specific to this line item */
14722
+ /** BG-27
14723
+ Allowances specific to this line item */
14430
14724
  allowances?: LineItemAllowance[] | undefined;
14431
- /** charges specific to this line item */
14725
+ /** BG-28
14726
+ charges specific to this line item */
14432
14727
  charges?: LineItemCharge[] | undefined;
14433
- /** Price details for this line item. */
14728
+ /** BG-29
14729
+ Price details for this line item. */
14434
14730
  priceDetails?: LineItemPriceDetail | undefined;
14435
- /** VAT information for this line item */
14731
+ /** BG-30
14732
+ VAT information for this line item */
14436
14733
  vatInformation?: LineItemVatInformation[] | undefined;
14437
- /** Information about this line item */
14734
+ /** BG-31
14735
+ Information about this line item */
14438
14736
  itemInformation?: LineItemInformation | undefined;
14439
- /** Line items can be nested, in which case this property holds the sub items */
14737
+ /** BG-DEX-01
14738
+ Line items can be nested, in which case this property holds the sub items */
14440
14739
  subItems?: InvoiceLineItem[] | undefined;
14441
14740
 
14442
14741
  constructor(data?: IInvoiceLineItem) {
@@ -14599,55 +14898,74 @@ See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Reg
14599
14898
 
14600
14899
  /** Represents a single invoice line item */
14601
14900
  export interface IInvoiceLineItem {
14602
- /** An unique identifier for the line item */
14901
+ /** BT-126
14902
+ An unique identifier for the line item */
14603
14903
  identifier?: string | undefined;
14604
- /** An unstructured note to classify line items */
14904
+ /** BT-127
14905
+ An unstructured note to classify line items */
14605
14906
  note?: string | undefined;
14606
- /** A seller-defined object identifier for this line item,
14907
+ /** BT-128
14908
+ A seller-defined object identifier for this line item,
14607
14909
  meaning an identifier for the actual line. This could be
14608
14910
  a numbering sequence or a reference to a product. */
14609
14911
  objectIdentifier?: string | undefined;
14610
- /** The actual invoiced quantity of the line item */
14912
+ /** BT-129
14913
+ The actual invoiced quantity of the line item */
14611
14914
  quantity?: number | undefined;
14612
- /** A code for the unit of the quantity. This should be a code as defined
14915
+ /** BT-130
14916
+ A code for the unit of the quantity. This should be a code as defined
14613
14917
  in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
14614
14918
  International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
14615
14919
  Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names).
14616
14920
  See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931 */
14617
14921
  unitCode?: string | undefined;
14618
- /** The net amount for this line item. This is the total price for positions */
14922
+ /** BT-131
14923
+ The net amount for this line item. This is the total price for positions */
14619
14924
  netAmount?: number | undefined;
14620
- /** A reference to an item in the buyers purachase order */
14925
+ /** BT-132
14926
+ A reference to an item in the buyers purachase order */
14621
14927
  purchaseOrderReference?: string | undefined;
14622
- /** Information about the invoice period for this line item. */
14928
+ /** BG-26
14929
+ Information about the invoice period for this line item. */
14623
14930
  lineItemPeriod?: IInvoicePeriod | undefined;
14624
- /** Allowances specific to this line item */
14931
+ /** BG-27
14932
+ Allowances specific to this line item */
14625
14933
  allowances?: ILineItemAllowance[] | undefined;
14626
- /** charges specific to this line item */
14934
+ /** BG-28
14935
+ charges specific to this line item */
14627
14936
  charges?: ILineItemCharge[] | undefined;
14628
- /** Price details for this line item. */
14937
+ /** BG-29
14938
+ Price details for this line item. */
14629
14939
  priceDetails?: ILineItemPriceDetail | undefined;
14630
- /** VAT information for this line item */
14940
+ /** BG-30
14941
+ VAT information for this line item */
14631
14942
  vatInformation?: ILineItemVatInformation[] | undefined;
14632
- /** Information about this line item */
14943
+ /** BG-31
14944
+ Information about this line item */
14633
14945
  itemInformation?: ILineItemInformation | undefined;
14634
- /** Line items can be nested, in which case this property holds the sub items */
14946
+ /** BG-DEX-01
14947
+ Line items can be nested, in which case this property holds the sub items */
14635
14948
  subItems?: IInvoiceLineItem[] | undefined;
14636
14949
  }
14637
14950
 
14638
14951
  /** Allowance for a single line item */
14639
14952
  export class LineItemAllowance implements ILineItemAllowance {
14640
- /** The net amount of the allowance */
14953
+ /** BT-136
14954
+ The net amount of the allowance */
14641
14955
  netAmount?: number | undefined;
14642
- /** If this is a relative / percentage allowance, this should be set
14956
+ /** BT-137
14957
+ If this is a relative / percentage allowance, this should be set
14643
14958
  and give the base amount that is being used for the calculation */
14644
14959
  relativeAllowanceBaseAmount?: number | undefined;
14645
- /** If this is a relative / percentage allowance, this should be set
14960
+ /** BT-138
14961
+ If this is a relative / percentage allowance, this should be set
14646
14962
  and be given in decimal representation, meaning 19% would be 0.19 */
14647
14963
  relativeAllowancePercentage?: number | undefined;
14648
- /** A description of the allowance. */
14964
+ /** BT-139
14965
+ A description of the allowance. */
14649
14966
  reason?: string | undefined;
14650
- /** A reason code for the allowance according to UNTDID 5189. Should be a code
14967
+ /** BT-140
14968
+ A reason code for the allowance according to UNTDID 5189. Should be a code
14651
14969
  from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
14652
14970
  reasonCode?: string | undefined;
14653
14971
  /** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
@@ -14695,17 +15013,22 @@ and is a read-only property. */
14695
15013
 
14696
15014
  /** Allowance for a single line item */
14697
15015
  export interface ILineItemAllowance {
14698
- /** The net amount of the allowance */
15016
+ /** BT-136
15017
+ The net amount of the allowance */
14699
15018
  netAmount?: number | undefined;
14700
- /** If this is a relative / percentage allowance, this should be set
15019
+ /** BT-137
15020
+ If this is a relative / percentage allowance, this should be set
14701
15021
  and give the base amount that is being used for the calculation */
14702
15022
  relativeAllowanceBaseAmount?: number | undefined;
14703
- /** If this is a relative / percentage allowance, this should be set
15023
+ /** BT-138
15024
+ If this is a relative / percentage allowance, this should be set
14704
15025
  and be given in decimal representation, meaning 19% would be 0.19 */
14705
15026
  relativeAllowancePercentage?: number | undefined;
14706
- /** A description of the allowance. */
15027
+ /** BT-139
15028
+ A description of the allowance. */
14707
15029
  reason?: string | undefined;
14708
- /** A reason code for the allowance according to UNTDID 5189. Should be a code
15030
+ /** BT-140
15031
+ A reason code for the allowance according to UNTDID 5189. Should be a code
14709
15032
  from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
14710
15033
  reasonCode?: string | undefined;
14711
15034
  /** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
@@ -14715,17 +15038,22 @@ and is a read-only property. */
14715
15038
 
14716
15039
  /** Charge for a single line item */
14717
15040
  export class LineItemCharge implements ILineItemCharge {
14718
- /** The net amount of the charge */
15041
+ /** BT-141
15042
+ The net amount of the charge */
14719
15043
  netAmount?: number | undefined;
14720
- /** If this is a relative / percentage charge, this should be set
15044
+ /** BT-142
15045
+ If this is a relative / percentage charge, this should be set
14721
15046
  and give the base amount that is being used for the calculation */
14722
15047
  relativeChargeBaseAmount?: number | undefined;
14723
- /** If this is a relative / percentage charge, this should be set
15048
+ /** BT-143
15049
+ If this is a relative / percentage charge, this should be set
14724
15050
  and be given in decimal representation, meaning 19% would be 0.19 */
14725
15051
  relativeChargePercentage?: number | undefined;
14726
- /** A description of the charge. */
15052
+ /** BT-144
15053
+ A description of the charge. */
14727
15054
  reason?: string | undefined;
14728
- /** A reason code for the charge according to UNTDID 7161.
15055
+ /** BT-145
15056
+ A reason code for the charge according to UNTDID 7161.
14729
15057
  See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
14730
15058
  reasonCode?: string | undefined;
14731
15059
  /** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
@@ -14773,17 +15101,22 @@ and is a read-only property. */
14773
15101
 
14774
15102
  /** Charge for a single line item */
14775
15103
  export interface ILineItemCharge {
14776
- /** The net amount of the charge */
15104
+ /** BT-141
15105
+ The net amount of the charge */
14777
15106
  netAmount?: number | undefined;
14778
- /** If this is a relative / percentage charge, this should be set
15107
+ /** BT-142
15108
+ If this is a relative / percentage charge, this should be set
14779
15109
  and give the base amount that is being used for the calculation */
14780
15110
  relativeChargeBaseAmount?: number | undefined;
14781
- /** If this is a relative / percentage charge, this should be set
15111
+ /** BT-143
15112
+ If this is a relative / percentage charge, this should be set
14782
15113
  and be given in decimal representation, meaning 19% would be 0.19 */
14783
15114
  relativeChargePercentage?: number | undefined;
14784
- /** A description of the charge. */
15115
+ /** BT-144
15116
+ A description of the charge. */
14785
15117
  reason?: string | undefined;
14786
- /** A reason code for the charge according to UNTDID 7161.
15118
+ /** BT-145
15119
+ A reason code for the charge according to UNTDID 7161.
14787
15120
  See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
14788
15121
  reasonCode?: string | undefined;
14789
15122
  /** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
@@ -14793,18 +15126,23 @@ and is a read-only property. */
14793
15126
 
14794
15127
  /** Price details about a line item */
14795
15128
  export class LineItemPriceDetail implements ILineItemPriceDetail {
14796
- /** The net price of this line item. This is the unit price */
15129
+ /** BT-146
15130
+ The net price of this line item. This is the unit price */
14797
15131
  netPrice?: number | undefined;
14798
- /** A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
15132
+ /** BT-147
15133
+ A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
14799
15134
  and the actual invoiced price GrossPrice. */
14800
15135
  absoluteDiscountPerItem?: number | undefined;
14801
- /** The gross price of this line item, meaning the price without taxes
15136
+ /** BT-148
15137
+ The gross price of this line item, meaning the price without taxes
14802
15138
  that will be invoiced */
14803
15139
  grossPrice?: number | undefined;
14804
- /** The quantity for which this price is valid. In combination with the NetPrice,
15140
+ /** BT-149
15141
+ The quantity for which this price is valid. In combination with the NetPrice,
14805
15142
  you basically specify the denominator of the unit price for a line item. */
14806
15143
  baseQuantity?: number | undefined;
14807
- /** A code representing the unit for the base quantity */
15144
+ /** BT-150
15145
+ A code representing the unit for the base quantity */
14808
15146
  baseQuantityUnitCode?: string | undefined;
14809
15147
 
14810
15148
  constructor(data?: ILineItemPriceDetail) {
@@ -14846,26 +15184,33 @@ you basically specify the denominator of the unit price for a line item. */
14846
15184
 
14847
15185
  /** Price details about a line item */
14848
15186
  export interface ILineItemPriceDetail {
14849
- /** The net price of this line item. This is the unit price */
15187
+ /** BT-146
15188
+ The net price of this line item. This is the unit price */
14850
15189
  netPrice?: number | undefined;
14851
- /** A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
15190
+ /** BT-147
15191
+ A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
14852
15192
  and the actual invoiced price GrossPrice. */
14853
15193
  absoluteDiscountPerItem?: number | undefined;
14854
- /** The gross price of this line item, meaning the price without taxes
15194
+ /** BT-148
15195
+ The gross price of this line item, meaning the price without taxes
14855
15196
  that will be invoiced */
14856
15197
  grossPrice?: number | undefined;
14857
- /** The quantity for which this price is valid. In combination with the NetPrice,
15198
+ /** BT-149
15199
+ The quantity for which this price is valid. In combination with the NetPrice,
14858
15200
  you basically specify the denominator of the unit price for a line item. */
14859
15201
  baseQuantity?: number | undefined;
14860
- /** A code representing the unit for the base quantity */
15202
+ /** BT-150
15203
+ A code representing the unit for the base quantity */
14861
15204
  baseQuantityUnitCode?: string | undefined;
14862
15205
  }
14863
15206
 
14864
15207
  /** VAT information for a single line item */
14865
15208
  export class LineItemVatInformation implements ILineItemVatInformation {
14866
- /** The VAT category for the charge */
15209
+ /** BT-151
15210
+ The VAT category for the charge */
14867
15211
  vatCategory!: VatCategory;
14868
- /** The actual tax rate as a decimal value,
15212
+ /** BT-152
15213
+ The actual tax rate as a decimal value,
14869
15214
  meaning 19% would be 0.19 */
14870
15215
  vatRate?: number | undefined;
14871
15216
 
@@ -14902,37 +15247,49 @@ meaning 19% would be 0.19 */
14902
15247
 
14903
15248
  /** VAT information for a single line item */
14904
15249
  export interface ILineItemVatInformation {
14905
- /** The VAT category for the charge */
15250
+ /** BT-151
15251
+ The VAT category for the charge */
14906
15252
  vatCategory: VatCategory;
14907
- /** The actual tax rate as a decimal value,
15253
+ /** BT-152
15254
+ The actual tax rate as a decimal value,
14908
15255
  meaning 19% would be 0.19 */
14909
15256
  vatRate?: number | undefined;
14910
15257
  }
14911
15258
 
14912
15259
  /** Information about a single line item */
14913
15260
  export class LineItemInformation implements ILineItemInformation {
14914
- /** A name for the line item */
15261
+ /** BT-153
15262
+ A name for the line item */
14915
15263
  name?: string | undefined;
14916
- /** A description for the line item */
15264
+ /** BT-154
15265
+ A description for the line item */
14917
15266
  description?: string | undefined;
14918
- /** An identifier assigned by the seller, e.g. an internal article number */
15267
+ /** BT-155
15268
+ An identifier assigned by the seller, e.g. an internal article number */
14919
15269
  sellerIdentifier?: string | undefined;
14920
- /** An identifier assigned by the buyer, e.g. an internal article number */
15270
+ /** BT-156
15271
+ An identifier assigned by the buyer, e.g. an internal article number */
14921
15272
  buyerIdentifier?: string | undefined;
14922
- /** A standard identifier for the line item, e.g. an EAN or a GTIN */
15273
+ /** BT-157
15274
+ A standard identifier for the line item, e.g. an EAN or a GTIN */
14923
15275
  standardIdentifier?: string | undefined;
14924
- /** If used together with StandardIdentifier, this is the scheme identifier
15276
+ /** BT-157
15277
+ If used together with StandardIdentifier, this is the scheme identifier
14925
15278
  for which standard is used. */
14926
15279
  standardSchemeId?: string | undefined;
14927
- /** A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
15280
+ /** BT-158
15281
+ A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
14928
15282
  classificationIdentifiers?: string[] | undefined;
14929
- /** This is used in connection with ClassificationIdentifiers. It is the scheme identifier
15283
+ /** BT-158
15284
+ This is used in connection with ClassificationIdentifiers. It is the scheme identifier
14930
15285
  for each identifier. If this list is used, it should have the same length as ClassificationIdentifiers, with null or empty values used
14931
15286
  for non-existing scheme identifiers. */
14932
15287
  classificationTypes?: string[] | undefined;
14933
- /** The origin country code according to ISO 3166-1 in 2 letter format */
15288
+ /** BT-159
15289
+ The origin country code according to ISO 3166-1 in 2 letter format */
14934
15290
  countryOfOrigin?: string | undefined;
14935
- /** Optional additional attributes for this line item */
15291
+ /** BG-32
15292
+ Optional additional attributes for this line item */
14936
15293
  attributes?: LineItemAttribute[] | undefined;
14937
15294
 
14938
15295
  constructor(data?: ILineItemInformation) {
@@ -15019,36 +15376,48 @@ for non-existing scheme identifiers. */
15019
15376
 
15020
15377
  /** Information about a single line item */
15021
15378
  export interface ILineItemInformation {
15022
- /** A name for the line item */
15379
+ /** BT-153
15380
+ A name for the line item */
15023
15381
  name?: string | undefined;
15024
- /** A description for the line item */
15382
+ /** BT-154
15383
+ A description for the line item */
15025
15384
  description?: string | undefined;
15026
- /** An identifier assigned by the seller, e.g. an internal article number */
15385
+ /** BT-155
15386
+ An identifier assigned by the seller, e.g. an internal article number */
15027
15387
  sellerIdentifier?: string | undefined;
15028
- /** An identifier assigned by the buyer, e.g. an internal article number */
15388
+ /** BT-156
15389
+ An identifier assigned by the buyer, e.g. an internal article number */
15029
15390
  buyerIdentifier?: string | undefined;
15030
- /** A standard identifier for the line item, e.g. an EAN or a GTIN */
15391
+ /** BT-157
15392
+ A standard identifier for the line item, e.g. an EAN or a GTIN */
15031
15393
  standardIdentifier?: string | undefined;
15032
- /** If used together with StandardIdentifier, this is the scheme identifier
15394
+ /** BT-157
15395
+ If used together with StandardIdentifier, this is the scheme identifier
15033
15396
  for which standard is used. */
15034
15397
  standardSchemeId?: string | undefined;
15035
- /** A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
15398
+ /** BT-158
15399
+ A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
15036
15400
  classificationIdentifiers?: string[] | undefined;
15037
- /** This is used in connection with ClassificationIdentifiers. It is the scheme identifier
15401
+ /** BT-158
15402
+ This is used in connection with ClassificationIdentifiers. It is the scheme identifier
15038
15403
  for each identifier. If this list is used, it should have the same length as ClassificationIdentifiers, with null or empty values used
15039
15404
  for non-existing scheme identifiers. */
15040
15405
  classificationTypes?: string[] | undefined;
15041
- /** The origin country code according to ISO 3166-1 in 2 letter format */
15406
+ /** BT-159
15407
+ The origin country code according to ISO 3166-1 in 2 letter format */
15042
15408
  countryOfOrigin?: string | undefined;
15043
- /** Optional additional attributes for this line item */
15409
+ /** BG-32
15410
+ Optional additional attributes for this line item */
15044
15411
  attributes?: ILineItemAttribute[] | undefined;
15045
15412
  }
15046
15413
 
15047
15414
  /** A key-value pair for additional information */
15048
15415
  export class LineItemAttribute implements ILineItemAttribute {
15049
- /** The key / name of the attribute */
15416
+ /** BT-160
15417
+ The key / name of the attribute */
15050
15418
  name!: string;
15051
- /** The value of the attribute */
15419
+ /** BT-161
15420
+ The value of the attribute */
15052
15421
  value?: string | undefined;
15053
15422
 
15054
15423
  constructor(data?: ILineItemAttribute) {
@@ -15084,9 +15453,11 @@ export class LineItemAttribute implements ILineItemAttribute {
15084
15453
 
15085
15454
  /** A key-value pair for additional information */
15086
15455
  export interface ILineItemAttribute {
15087
- /** The key / name of the attribute */
15456
+ /** BT-160
15457
+ The key / name of the attribute */
15088
15458
  name: string;
15089
- /** The value of the attribute */
15459
+ /** BT-161
15460
+ The value of the attribute */
15090
15461
  value?: string | undefined;
15091
15462
  }
15092
15463