@dangl/avacloud-client-node 1.60.6-beta0001-avacloud-preview → 1.60.7-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.
- package/api.d.ts +598 -280
- package/api.js +57 -1
- package/api.js.map +1 -1
- package/api.ts +651 -280
- package/package.json +1 -1
package/api.d.ts
CHANGED
|
@@ -3426,6 +3426,8 @@ export declare class OenormNoteTextPropertiesDto implements IOenormNoteTextPrope
|
|
|
3426
3426
|
originCode: OenormOriginCodeDto;
|
|
3427
3427
|
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
3428
3428
|
openingTextIsFreeText: boolean;
|
|
3429
|
+
/** 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 */
|
|
3430
|
+
isUndividedPosition: boolean;
|
|
3429
3431
|
constructor(data?: IOenormNoteTextPropertiesDto);
|
|
3430
3432
|
init?(_data?: any): void;
|
|
3431
3433
|
static fromJS(data: any): OenormNoteTextPropertiesDto;
|
|
@@ -3437,6 +3439,8 @@ export interface IOenormNoteTextPropertiesDto {
|
|
|
3437
3439
|
originCode: OenormOriginCodeDto;
|
|
3438
3440
|
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
3439
3441
|
openingTextIsFreeText: boolean;
|
|
3442
|
+
/** 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 */
|
|
3443
|
+
isUndividedPosition: boolean;
|
|
3440
3444
|
}
|
|
3441
3445
|
/** This is a grouping IElement that holds other IElements within. */
|
|
3442
3446
|
export declare class ServiceSpecificationGroupDto extends IElementDto implements IServiceSpecificationGroupDto {
|
|
@@ -4289,8 +4293,13 @@ Until when the payment is due */
|
|
|
4289
4293
|
paymentDueDate?: Date | undefined;
|
|
4290
4294
|
/** An object holding reference used in this invoice */
|
|
4291
4295
|
references?: References | undefined;
|
|
4292
|
-
/**
|
|
4296
|
+
/** BT-20
|
|
4297
|
+
A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4293
4298
|
paymentTerms?: string | undefined;
|
|
4299
|
+
/** If the PaymentTerms are present and in a correct format, this read-only property
|
|
4300
|
+
can be used to get the actual parsed payment terms in a deserialized and structured format. This will
|
|
4301
|
+
be null if PaymentTerms are not present or not in the correct format */
|
|
4302
|
+
parsedPaymentTerms?: PaymentTerm[] | undefined;
|
|
4294
4303
|
/** BG-3
|
|
4295
4304
|
In case of partial or final invoices, it's possible to reference the previous invoice numbers */
|
|
4296
4305
|
previousInvoices?: PreviousInvoice[] | undefined;
|
|
@@ -4306,27 +4315,36 @@ Information about the sellers tax representative */
|
|
|
4306
4315
|
/** BG-10
|
|
4307
4316
|
A payee is someone who receives the payment that is different from the seller */
|
|
4308
4317
|
payee?: Payee | undefined;
|
|
4309
|
-
/**
|
|
4318
|
+
/** BG-1
|
|
4319
|
+
If present, this is an unstructured text that can be used to give additional information
|
|
4310
4320
|
about the invoice. Field BG-1 */
|
|
4311
4321
|
invoiceNotes?: InvoiceNote[] | undefined;
|
|
4312
|
-
/**
|
|
4322
|
+
/** BG-14
|
|
4323
|
+
The period during which the services or goods were delivered */
|
|
4313
4324
|
invoicePeriod?: InvoicePeriod | undefined;
|
|
4314
|
-
/**
|
|
4325
|
+
/** BG-13
|
|
4326
|
+
Information about the delivery
|
|
4315
4327
|
BG-13 in XRechnung */
|
|
4316
4328
|
deliveryInformation?: DeliveryInformation | undefined;
|
|
4317
|
-
/**
|
|
4329
|
+
/** BG-22
|
|
4330
|
+
Totals for the invoice */
|
|
4318
4331
|
totals?: InvoiceTotals | undefined;
|
|
4319
4332
|
/** Instructions how to perform the payment */
|
|
4320
4333
|
paymentInstructions?: PaymentInstructions | undefined;
|
|
4321
|
-
/**
|
|
4334
|
+
/** BG-24
|
|
4335
|
+
Attached documents to the invoice */
|
|
4322
4336
|
documents?: SupportingDocument[] | undefined;
|
|
4323
|
-
/**
|
|
4337
|
+
/** BG-23
|
|
4338
|
+
This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
|
|
4324
4339
|
vatBreakdown?: VatBreakdown[] | undefined;
|
|
4325
|
-
/**
|
|
4340
|
+
/** BG-20
|
|
4341
|
+
Allowances / deductions on the invoice */
|
|
4326
4342
|
allowances?: InvoiceAllowance[] | undefined;
|
|
4327
|
-
/**
|
|
4343
|
+
/** BG-21
|
|
4344
|
+
Charges / additional costs on the invoice */
|
|
4328
4345
|
charges?: InvoiceCharge[] | undefined;
|
|
4329
|
-
/**
|
|
4346
|
+
/** BG-25
|
|
4347
|
+
Single line items in the invoice */
|
|
4330
4348
|
lineItems?: InvoiceLineItem[] | undefined;
|
|
4331
4349
|
/** The source type from which the invoice was created */
|
|
4332
4350
|
sourceType: SourceType;
|
|
@@ -4354,8 +4372,13 @@ Until when the payment is due */
|
|
|
4354
4372
|
paymentDueDate?: Date | undefined;
|
|
4355
4373
|
/** An object holding reference used in this invoice */
|
|
4356
4374
|
references?: IReferences | undefined;
|
|
4357
|
-
/**
|
|
4375
|
+
/** BT-20
|
|
4376
|
+
A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4358
4377
|
paymentTerms?: string | undefined;
|
|
4378
|
+
/** If the PaymentTerms are present and in a correct format, this read-only property
|
|
4379
|
+
can be used to get the actual parsed payment terms in a deserialized and structured format. This will
|
|
4380
|
+
be null if PaymentTerms are not present or not in the correct format */
|
|
4381
|
+
parsedPaymentTerms?: IPaymentTerm[] | undefined;
|
|
4359
4382
|
/** BG-3
|
|
4360
4383
|
In case of partial or final invoices, it's possible to reference the previous invoice numbers */
|
|
4361
4384
|
previousInvoices?: IPreviousInvoice[] | undefined;
|
|
@@ -4371,27 +4394,36 @@ Information about the sellers tax representative */
|
|
|
4371
4394
|
/** BG-10
|
|
4372
4395
|
A payee is someone who receives the payment that is different from the seller */
|
|
4373
4396
|
payee?: IPayee | undefined;
|
|
4374
|
-
/**
|
|
4397
|
+
/** BG-1
|
|
4398
|
+
If present, this is an unstructured text that can be used to give additional information
|
|
4375
4399
|
about the invoice. Field BG-1 */
|
|
4376
4400
|
invoiceNotes?: IInvoiceNote[] | undefined;
|
|
4377
|
-
/**
|
|
4401
|
+
/** BG-14
|
|
4402
|
+
The period during which the services or goods were delivered */
|
|
4378
4403
|
invoicePeriod?: IInvoicePeriod | undefined;
|
|
4379
|
-
/**
|
|
4404
|
+
/** BG-13
|
|
4405
|
+
Information about the delivery
|
|
4380
4406
|
BG-13 in XRechnung */
|
|
4381
4407
|
deliveryInformation?: IDeliveryInformation | undefined;
|
|
4382
|
-
/**
|
|
4408
|
+
/** BG-22
|
|
4409
|
+
Totals for the invoice */
|
|
4383
4410
|
totals?: IInvoiceTotals | undefined;
|
|
4384
4411
|
/** Instructions how to perform the payment */
|
|
4385
4412
|
paymentInstructions?: IPaymentInstructions | undefined;
|
|
4386
|
-
/**
|
|
4413
|
+
/** BG-24
|
|
4414
|
+
Attached documents to the invoice */
|
|
4387
4415
|
documents?: ISupportingDocument[] | undefined;
|
|
4388
|
-
/**
|
|
4416
|
+
/** BG-23
|
|
4417
|
+
This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories */
|
|
4389
4418
|
vatBreakdown?: IVatBreakdown[] | undefined;
|
|
4390
|
-
/**
|
|
4419
|
+
/** BG-20
|
|
4420
|
+
Allowances / deductions on the invoice */
|
|
4391
4421
|
allowances?: IInvoiceAllowance[] | undefined;
|
|
4392
|
-
/**
|
|
4422
|
+
/** BG-21
|
|
4423
|
+
Charges / additional costs on the invoice */
|
|
4393
4424
|
charges?: IInvoiceCharge[] | undefined;
|
|
4394
|
-
/**
|
|
4425
|
+
/** BG-25
|
|
4426
|
+
Single line items in the invoice */
|
|
4395
4427
|
lineItems?: IInvoiceLineItem[] | undefined;
|
|
4396
4428
|
/** The source type from which the invoice was created */
|
|
4397
4429
|
sourceType: SourceType;
|
|
@@ -4409,36 +4441,46 @@ export declare enum InvoiceType {
|
|
|
4409
4441
|
}
|
|
4410
4442
|
/** This class holds typical references used in an invoice */
|
|
4411
4443
|
export declare class References implements IReferences {
|
|
4412
|
-
/**
|
|
4444
|
+
/** BT-10
|
|
4445
|
+
An internal reference used by the buyer, this can also be used as the
|
|
4413
4446
|
'Leitweg-ID' in Germany
|
|
4414
4447
|
BT-10 in XRechnung. */
|
|
4415
4448
|
buyerReference?: string | undefined;
|
|
4416
|
-
/**
|
|
4449
|
+
/** BT-11
|
|
4450
|
+
Reference to a project
|
|
4417
4451
|
BT-11 in XRechnung. */
|
|
4418
4452
|
projectReference?: string | undefined;
|
|
4419
|
-
/**
|
|
4453
|
+
/** BT-12
|
|
4454
|
+
Reference to a contract
|
|
4420
4455
|
BT-12 in XRechnung. */
|
|
4421
4456
|
contractReference?: string | undefined;
|
|
4422
|
-
/**
|
|
4457
|
+
/** BT-13
|
|
4458
|
+
Reference to a purchase order created by the buyer
|
|
4423
4459
|
BT-13 in XRechnung. */
|
|
4424
4460
|
purchaseOrderReference?: string | undefined;
|
|
4425
|
-
/**
|
|
4461
|
+
/** BT-14
|
|
4462
|
+
Reference to a sales order created by the seller
|
|
4426
4463
|
BT-14 in XRechnung. */
|
|
4427
4464
|
salesOrderReference?: string | undefined;
|
|
4428
|
-
/**
|
|
4465
|
+
/** BT-15
|
|
4466
|
+
Reference to a delivery note
|
|
4429
4467
|
BT-15 in XRechnung. */
|
|
4430
4468
|
receivingAdviceReference?: string | undefined;
|
|
4431
|
-
/**
|
|
4469
|
+
/** BT-16
|
|
4470
|
+
Reference to a dispatch advice
|
|
4432
4471
|
BT-16 in XRechnung. */
|
|
4433
4472
|
dispatchAdviceReference?: string | undefined;
|
|
4434
|
-
/**
|
|
4473
|
+
/** BT-17
|
|
4474
|
+
Reference to a tender or lot
|
|
4435
4475
|
BT-17 in XRechnung. */
|
|
4436
4476
|
tenderOrLotReference?: string | undefined;
|
|
4437
|
-
/**
|
|
4477
|
+
/** BT-18
|
|
4478
|
+
Reference to a custom item, e.g. a phone number, person,
|
|
4438
4479
|
contract or anything that would identify the invoice in the buyer's system
|
|
4439
4480
|
BT-18 in XRechnung. */
|
|
4440
4481
|
invoicedObjectIdentifier?: string | undefined;
|
|
4441
|
-
/**
|
|
4482
|
+
/** BT-19
|
|
4483
|
+
This is a reference for accounting, like a cost center or similar. In German,
|
|
4442
4484
|
this would be a "Kostenstelle".
|
|
4443
4485
|
BT-19 in XRechnung. */
|
|
4444
4486
|
accountingReference?: string | undefined;
|
|
@@ -4449,40 +4491,72 @@ BT-19 in XRechnung. */
|
|
|
4449
4491
|
}
|
|
4450
4492
|
/** This class holds typical references used in an invoice */
|
|
4451
4493
|
export interface IReferences {
|
|
4452
|
-
/**
|
|
4494
|
+
/** BT-10
|
|
4495
|
+
An internal reference used by the buyer, this can also be used as the
|
|
4453
4496
|
'Leitweg-ID' in Germany
|
|
4454
4497
|
BT-10 in XRechnung. */
|
|
4455
4498
|
buyerReference?: string | undefined;
|
|
4456
|
-
/**
|
|
4499
|
+
/** BT-11
|
|
4500
|
+
Reference to a project
|
|
4457
4501
|
BT-11 in XRechnung. */
|
|
4458
4502
|
projectReference?: string | undefined;
|
|
4459
|
-
/**
|
|
4503
|
+
/** BT-12
|
|
4504
|
+
Reference to a contract
|
|
4460
4505
|
BT-12 in XRechnung. */
|
|
4461
4506
|
contractReference?: string | undefined;
|
|
4462
|
-
/**
|
|
4507
|
+
/** BT-13
|
|
4508
|
+
Reference to a purchase order created by the buyer
|
|
4463
4509
|
BT-13 in XRechnung. */
|
|
4464
4510
|
purchaseOrderReference?: string | undefined;
|
|
4465
|
-
/**
|
|
4511
|
+
/** BT-14
|
|
4512
|
+
Reference to a sales order created by the seller
|
|
4466
4513
|
BT-14 in XRechnung. */
|
|
4467
4514
|
salesOrderReference?: string | undefined;
|
|
4468
|
-
/**
|
|
4515
|
+
/** BT-15
|
|
4516
|
+
Reference to a delivery note
|
|
4469
4517
|
BT-15 in XRechnung. */
|
|
4470
4518
|
receivingAdviceReference?: string | undefined;
|
|
4471
|
-
/**
|
|
4519
|
+
/** BT-16
|
|
4520
|
+
Reference to a dispatch advice
|
|
4472
4521
|
BT-16 in XRechnung. */
|
|
4473
4522
|
dispatchAdviceReference?: string | undefined;
|
|
4474
|
-
/**
|
|
4523
|
+
/** BT-17
|
|
4524
|
+
Reference to a tender or lot
|
|
4475
4525
|
BT-17 in XRechnung. */
|
|
4476
4526
|
tenderOrLotReference?: string | undefined;
|
|
4477
|
-
/**
|
|
4527
|
+
/** BT-18
|
|
4528
|
+
Reference to a custom item, e.g. a phone number, person,
|
|
4478
4529
|
contract or anything that would identify the invoice in the buyer's system
|
|
4479
4530
|
BT-18 in XRechnung. */
|
|
4480
4531
|
invoicedObjectIdentifier?: string | undefined;
|
|
4481
|
-
/**
|
|
4532
|
+
/** BT-19
|
|
4533
|
+
This is a reference for accounting, like a cost center or similar. In German,
|
|
4482
4534
|
this would be a "Kostenstelle".
|
|
4483
4535
|
BT-19 in XRechnung. */
|
|
4484
4536
|
accountingReference?: string | undefined;
|
|
4485
4537
|
}
|
|
4538
|
+
/** Represents a discount with a number of days, percentage, and an optional base amount. */
|
|
4539
|
+
export declare class PaymentTerm implements IPaymentTerm {
|
|
4540
|
+
/** The number of days until the discount is valid. */
|
|
4541
|
+
days: number;
|
|
4542
|
+
/** The percentage of the discount. */
|
|
4543
|
+
percent: number;
|
|
4544
|
+
/** The base amount for the discount, if applicable. */
|
|
4545
|
+
baseAmount?: number | undefined;
|
|
4546
|
+
constructor(data?: IPaymentTerm);
|
|
4547
|
+
init?(_data?: any): void;
|
|
4548
|
+
static fromJS(data: any): PaymentTerm;
|
|
4549
|
+
toJSON?(data?: any): any;
|
|
4550
|
+
}
|
|
4551
|
+
/** Represents a discount with a number of days, percentage, and an optional base amount. */
|
|
4552
|
+
export interface IPaymentTerm {
|
|
4553
|
+
/** The number of days until the discount is valid. */
|
|
4554
|
+
days: number;
|
|
4555
|
+
/** The percentage of the discount. */
|
|
4556
|
+
percent: number;
|
|
4557
|
+
/** The base amount for the discount, if applicable. */
|
|
4558
|
+
baseAmount?: number | undefined;
|
|
4559
|
+
}
|
|
4486
4560
|
/** References to previous invoices */
|
|
4487
4561
|
export declare class PreviousInvoice implements IPreviousInvoice {
|
|
4488
4562
|
/** BT-26
|
|
@@ -4507,35 +4581,52 @@ The number of the previous invoice */
|
|
|
4507
4581
|
}
|
|
4508
4582
|
/** Represents an organization, e.g. a buyer or a seller */
|
|
4509
4583
|
export declare class Organization implements IOrganization {
|
|
4510
|
-
/**
|
|
4584
|
+
/** BT-46 (BT-29 for the Seller)
|
|
4585
|
+
The identifier of the organization */
|
|
4511
4586
|
identifier?: string | undefined;
|
|
4512
|
-
/**
|
|
4587
|
+
/** BT-44 (BT-27 for the seller, BT-62 for the seller tax representative)
|
|
4588
|
+
The name of the organization */
|
|
4513
4589
|
name?: string | undefined;
|
|
4514
|
-
/**
|
|
4590
|
+
/** BT-30, for the seller, doesn't exist in the buyer actually
|
|
4591
|
+
A registration number, e.g. a Handelsregisternummer in Germany */
|
|
4515
4592
|
registrationNumber?: string | undefined;
|
|
4516
|
-
/**
|
|
4593
|
+
/** BT-48, BT-32 for the seller, BT-63 for the seller tax representative
|
|
4594
|
+
The VAT ID for the organization */
|
|
4517
4595
|
vatId?: string | undefined;
|
|
4518
|
-
/**
|
|
4596
|
+
/** BT-32 for the seller, does not exist for the buyer
|
|
4597
|
+
The tax ID for the organization */
|
|
4519
4598
|
taxId?: string | undefined;
|
|
4520
|
-
/**
|
|
4599
|
+
/** BT-49
|
|
4600
|
+
An email address for the organization */
|
|
4521
4601
|
email?: string | undefined;
|
|
4522
|
-
/**
|
|
4602
|
+
/** BT-56
|
|
4603
|
+
The name of a contact person */
|
|
4523
4604
|
contactPersonName?: string | undefined;
|
|
4524
|
-
/**
|
|
4605
|
+
/** BT-57
|
|
4606
|
+
The phone of a contact person */
|
|
4525
4607
|
contactPersonPhone?: string | undefined;
|
|
4526
|
-
/**
|
|
4608
|
+
/** BT-58
|
|
4609
|
+
The email of a contact person */
|
|
4527
4610
|
contactPersonEmail?: string | undefined;
|
|
4528
|
-
/**
|
|
4611
|
+
/** BT-50, BT-35 for the seller, BT-64 for the seller tax representative
|
|
4612
|
+
BT-51, BT-36 for the seller, BT-65 for the seller tax representative
|
|
4613
|
+
BT-163, BT-162 for the seller, BT-164 for the seller tax representative
|
|
4614
|
+
The address of the organization */
|
|
4529
4615
|
address?: string | undefined;
|
|
4530
|
-
/**
|
|
4616
|
+
/** BT-52, BT-37 for the seller, BT-66 for the seller tax representative
|
|
4617
|
+
The city of the organization */
|
|
4531
4618
|
city?: string | undefined;
|
|
4532
|
-
/**
|
|
4619
|
+
/** BT-53, BT-38 for the seller, BT-67 for the seller tax representative
|
|
4620
|
+
The zip code of the organization */
|
|
4533
4621
|
zipCode?: string | undefined;
|
|
4534
|
-
/**
|
|
4622
|
+
/** BT-55, BT-40 for the seller, BT-69 for the seller tax representative
|
|
4623
|
+
The ISO 3166-1 2 letter country code */
|
|
4535
4624
|
countryCode?: string | undefined;
|
|
4536
|
-
/**
|
|
4625
|
+
/** BT-54, BT-39 for the seller, BT-68 for the seller tax representative
|
|
4626
|
+
The state of the organization, e.g. a federal state in Germany */
|
|
4537
4627
|
state?: string | undefined;
|
|
4538
|
-
/**
|
|
4628
|
+
/** BT-33
|
|
4629
|
+
This provides some additional legal information.
|
|
4539
4630
|
BT-33 in XRechnung, and this is only used for the seller. */
|
|
4540
4631
|
additionalLegalInformation?: string | undefined;
|
|
4541
4632
|
constructor(data?: IOrganization);
|
|
@@ -4545,45 +4636,65 @@ BT-33 in XRechnung, and this is only used for the seller. */
|
|
|
4545
4636
|
}
|
|
4546
4637
|
/** Represents an organization, e.g. a buyer or a seller */
|
|
4547
4638
|
export interface IOrganization {
|
|
4548
|
-
/**
|
|
4639
|
+
/** BT-46 (BT-29 for the Seller)
|
|
4640
|
+
The identifier of the organization */
|
|
4549
4641
|
identifier?: string | undefined;
|
|
4550
|
-
/**
|
|
4642
|
+
/** BT-44 (BT-27 for the seller, BT-62 for the seller tax representative)
|
|
4643
|
+
The name of the organization */
|
|
4551
4644
|
name?: string | undefined;
|
|
4552
|
-
/**
|
|
4645
|
+
/** BT-30, for the seller, doesn't exist in the buyer actually
|
|
4646
|
+
A registration number, e.g. a Handelsregisternummer in Germany */
|
|
4553
4647
|
registrationNumber?: string | undefined;
|
|
4554
|
-
/**
|
|
4648
|
+
/** BT-48, BT-32 for the seller, BT-63 for the seller tax representative
|
|
4649
|
+
The VAT ID for the organization */
|
|
4555
4650
|
vatId?: string | undefined;
|
|
4556
|
-
/**
|
|
4651
|
+
/** BT-32 for the seller, does not exist for the buyer
|
|
4652
|
+
The tax ID for the organization */
|
|
4557
4653
|
taxId?: string | undefined;
|
|
4558
|
-
/**
|
|
4654
|
+
/** BT-49
|
|
4655
|
+
An email address for the organization */
|
|
4559
4656
|
email?: string | undefined;
|
|
4560
|
-
/**
|
|
4657
|
+
/** BT-56
|
|
4658
|
+
The name of a contact person */
|
|
4561
4659
|
contactPersonName?: string | undefined;
|
|
4562
|
-
/**
|
|
4660
|
+
/** BT-57
|
|
4661
|
+
The phone of a contact person */
|
|
4563
4662
|
contactPersonPhone?: string | undefined;
|
|
4564
|
-
/**
|
|
4663
|
+
/** BT-58
|
|
4664
|
+
The email of a contact person */
|
|
4565
4665
|
contactPersonEmail?: string | undefined;
|
|
4566
|
-
/**
|
|
4666
|
+
/** BT-50, BT-35 for the seller, BT-64 for the seller tax representative
|
|
4667
|
+
BT-51, BT-36 for the seller, BT-65 for the seller tax representative
|
|
4668
|
+
BT-163, BT-162 for the seller, BT-164 for the seller tax representative
|
|
4669
|
+
The address of the organization */
|
|
4567
4670
|
address?: string | undefined;
|
|
4568
|
-
/**
|
|
4671
|
+
/** BT-52, BT-37 for the seller, BT-66 for the seller tax representative
|
|
4672
|
+
The city of the organization */
|
|
4569
4673
|
city?: string | undefined;
|
|
4570
|
-
/**
|
|
4674
|
+
/** BT-53, BT-38 for the seller, BT-67 for the seller tax representative
|
|
4675
|
+
The zip code of the organization */
|
|
4571
4676
|
zipCode?: string | undefined;
|
|
4572
|
-
/**
|
|
4677
|
+
/** BT-55, BT-40 for the seller, BT-69 for the seller tax representative
|
|
4678
|
+
The ISO 3166-1 2 letter country code */
|
|
4573
4679
|
countryCode?: string | undefined;
|
|
4574
|
-
/**
|
|
4680
|
+
/** BT-54, BT-39 for the seller, BT-68 for the seller tax representative
|
|
4681
|
+
The state of the organization, e.g. a federal state in Germany */
|
|
4575
4682
|
state?: string | undefined;
|
|
4576
|
-
/**
|
|
4683
|
+
/** BT-33
|
|
4684
|
+
This provides some additional legal information.
|
|
4577
4685
|
BT-33 in XRechnung, and this is only used for the seller. */
|
|
4578
4686
|
additionalLegalInformation?: string | undefined;
|
|
4579
4687
|
}
|
|
4580
4688
|
/** Represents a payee, meaning someone that receives the payment */
|
|
4581
4689
|
export declare class Payee implements IPayee {
|
|
4582
|
-
/**
|
|
4690
|
+
/** BT-59
|
|
4691
|
+
The name of the payee */
|
|
4583
4692
|
name?: string | undefined;
|
|
4584
|
-
/**
|
|
4693
|
+
/** BT-60
|
|
4694
|
+
The identifier of the payee */
|
|
4585
4695
|
identifier?: string | undefined;
|
|
4586
|
-
/**
|
|
4696
|
+
/** BT-61
|
|
4697
|
+
A registered identifier for the payee, e.g. a VAT ID
|
|
4587
4698
|
or Tax ID */
|
|
4588
4699
|
legalRegistrationIdentifier?: string | undefined;
|
|
4589
4700
|
constructor(data?: IPayee);
|
|
@@ -4593,24 +4704,29 @@ or Tax ID */
|
|
|
4593
4704
|
}
|
|
4594
4705
|
/** Represents a payee, meaning someone that receives the payment */
|
|
4595
4706
|
export interface IPayee {
|
|
4596
|
-
/**
|
|
4707
|
+
/** BT-59
|
|
4708
|
+
The name of the payee */
|
|
4597
4709
|
name?: string | undefined;
|
|
4598
|
-
/**
|
|
4710
|
+
/** BT-60
|
|
4711
|
+
The identifier of the payee */
|
|
4599
4712
|
identifier?: string | undefined;
|
|
4600
|
-
/**
|
|
4713
|
+
/** BT-61
|
|
4714
|
+
A registered identifier for the payee, e.g. a VAT ID
|
|
4601
4715
|
or Tax ID */
|
|
4602
4716
|
legalRegistrationIdentifier?: string | undefined;
|
|
4603
4717
|
}
|
|
4604
4718
|
/** Represents a note / text in an invoice */
|
|
4605
4719
|
export declare class InvoiceNote implements IInvoiceNote {
|
|
4606
|
-
/**
|
|
4720
|
+
/** BT-21
|
|
4721
|
+
Short summary / heading. Should be a text code from this list:
|
|
4607
4722
|
https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4451.htm
|
|
4608
4723
|
Field BT-21 */
|
|
4609
4724
|
shortText?: string | undefined;
|
|
4610
4725
|
/** Short summary / heading type. This will be automatically parsed from ShortText
|
|
4611
4726
|
and is a read-only property. */
|
|
4612
4727
|
shortTextType?: ShortTextType | undefined;
|
|
4613
|
-
/**
|
|
4728
|
+
/** BT-22
|
|
4729
|
+
Explanation of this note
|
|
4614
4730
|
Field BT-22 */
|
|
4615
4731
|
longText?: string | undefined;
|
|
4616
4732
|
constructor(data?: IInvoiceNote);
|
|
@@ -4620,14 +4736,16 @@ Field BT-22 */
|
|
|
4620
4736
|
}
|
|
4621
4737
|
/** Represents a note / text in an invoice */
|
|
4622
4738
|
export interface IInvoiceNote {
|
|
4623
|
-
/**
|
|
4739
|
+
/** BT-21
|
|
4740
|
+
Short summary / heading. Should be a text code from this list:
|
|
4624
4741
|
https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4451.htm
|
|
4625
4742
|
Field BT-21 */
|
|
4626
4743
|
shortText?: string | undefined;
|
|
4627
4744
|
/** Short summary / heading type. This will be automatically parsed from ShortText
|
|
4628
4745
|
and is a read-only property. */
|
|
4629
4746
|
shortTextType?: ShortTextType | undefined;
|
|
4630
|
-
/**
|
|
4747
|
+
/** BT-22
|
|
4748
|
+
Explanation of this note
|
|
4631
4749
|
Field BT-22 */
|
|
4632
4750
|
longText?: string | undefined;
|
|
4633
4751
|
}
|
|
@@ -5015,9 +5133,11 @@ export declare enum ShortTextType {
|
|
|
5015
5133
|
}
|
|
5016
5134
|
/** Represents an invoice period with start and end dates */
|
|
5017
5135
|
export declare class InvoicePeriod implements IInvoicePeriod {
|
|
5018
|
-
/**
|
|
5136
|
+
/** BT-134
|
|
5137
|
+
The start date */
|
|
5019
5138
|
start?: Date | undefined;
|
|
5020
|
-
/**
|
|
5139
|
+
/** BT-135
|
|
5140
|
+
The end date */
|
|
5021
5141
|
end?: Date | undefined;
|
|
5022
5142
|
constructor(data?: IInvoicePeriod);
|
|
5023
5143
|
init?(_data?: any): void;
|
|
@@ -5026,20 +5146,26 @@ export declare class InvoicePeriod implements IInvoicePeriod {
|
|
|
5026
5146
|
}
|
|
5027
5147
|
/** Represents an invoice period with start and end dates */
|
|
5028
5148
|
export interface IInvoicePeriod {
|
|
5029
|
-
/**
|
|
5149
|
+
/** BT-134
|
|
5150
|
+
The start date */
|
|
5030
5151
|
start?: Date | undefined;
|
|
5031
|
-
/**
|
|
5152
|
+
/** BT-135
|
|
5153
|
+
The end date */
|
|
5032
5154
|
end?: Date | undefined;
|
|
5033
5155
|
}
|
|
5034
5156
|
/** Information about the delivery */
|
|
5035
5157
|
export declare class DeliveryInformation implements IDeliveryInformation {
|
|
5036
|
-
/** BT-70
|
|
5158
|
+
/** BT-70
|
|
5159
|
+
BT-70 in XRechnung */
|
|
5037
5160
|
deliverToName?: string | undefined;
|
|
5038
|
-
/** BT-71
|
|
5161
|
+
/** BT-71
|
|
5162
|
+
BT-71 in XRechnung */
|
|
5039
5163
|
deliverToLocationIdentifier?: string | undefined;
|
|
5040
|
-
/** BT-72
|
|
5164
|
+
/** BT-72
|
|
5165
|
+
BT-72 in XRechnung */
|
|
5041
5166
|
deliveryDate?: Date | undefined;
|
|
5042
|
-
/** BG-15
|
|
5167
|
+
/** BG-15
|
|
5168
|
+
BG-15 in XRechnung */
|
|
5043
5169
|
deliveryAddress?: DeliveryAddress | undefined;
|
|
5044
5170
|
constructor(data?: IDeliveryInformation);
|
|
5045
5171
|
init?(_data?: any): void;
|
|
@@ -5048,24 +5174,32 @@ export declare class DeliveryInformation implements IDeliveryInformation {
|
|
|
5048
5174
|
}
|
|
5049
5175
|
/** Information about the delivery */
|
|
5050
5176
|
export interface IDeliveryInformation {
|
|
5051
|
-
/** BT-70
|
|
5177
|
+
/** BT-70
|
|
5178
|
+
BT-70 in XRechnung */
|
|
5052
5179
|
deliverToName?: string | undefined;
|
|
5053
|
-
/** BT-71
|
|
5180
|
+
/** BT-71
|
|
5181
|
+
BT-71 in XRechnung */
|
|
5054
5182
|
deliverToLocationIdentifier?: string | undefined;
|
|
5055
|
-
/** BT-72
|
|
5183
|
+
/** BT-72
|
|
5184
|
+
BT-72 in XRechnung */
|
|
5056
5185
|
deliveryDate?: Date | undefined;
|
|
5057
|
-
/** BG-15
|
|
5186
|
+
/** BG-15
|
|
5187
|
+
BG-15 in XRechnung */
|
|
5058
5188
|
deliveryAddress?: IDeliveryAddress | undefined;
|
|
5059
5189
|
}
|
|
5060
5190
|
/** Address for deliveries */
|
|
5061
5191
|
export declare class DeliveryAddress implements IDeliveryAddress {
|
|
5062
|
-
/**
|
|
5192
|
+
/** BT-75, BT-76 and BT-165
|
|
5193
|
+
The address. BT-75, BT-76 and BT-165 in XRechnung. */
|
|
5063
5194
|
address?: string | undefined;
|
|
5064
|
-
/**
|
|
5195
|
+
/** BT-77
|
|
5196
|
+
The city. BT-77 in XRechnung. */
|
|
5065
5197
|
city?: string | undefined;
|
|
5066
|
-
/**
|
|
5198
|
+
/** BT-78
|
|
5199
|
+
The zip code. BT-78 in XRechnung. */
|
|
5067
5200
|
zipCode?: string | undefined;
|
|
5068
|
-
/**
|
|
5201
|
+
/** BT-80
|
|
5202
|
+
The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
|
|
5069
5203
|
countryCode?: string | undefined;
|
|
5070
5204
|
constructor(data?: IDeliveryAddress);
|
|
5071
5205
|
init?(_data?: any): void;
|
|
@@ -5074,46 +5208,59 @@ export declare class DeliveryAddress implements IDeliveryAddress {
|
|
|
5074
5208
|
}
|
|
5075
5209
|
/** Address for deliveries */
|
|
5076
5210
|
export interface IDeliveryAddress {
|
|
5077
|
-
/**
|
|
5211
|
+
/** BT-75, BT-76 and BT-165
|
|
5212
|
+
The address. BT-75, BT-76 and BT-165 in XRechnung. */
|
|
5078
5213
|
address?: string | undefined;
|
|
5079
|
-
/**
|
|
5214
|
+
/** BT-77
|
|
5215
|
+
The city. BT-77 in XRechnung. */
|
|
5080
5216
|
city?: string | undefined;
|
|
5081
|
-
/**
|
|
5217
|
+
/** BT-78
|
|
5218
|
+
The zip code. BT-78 in XRechnung. */
|
|
5082
5219
|
zipCode?: string | undefined;
|
|
5083
|
-
/**
|
|
5220
|
+
/** BT-80
|
|
5221
|
+
The ISO 3166-1 2 letter country code. BT-80 in XRechnung. */
|
|
5084
5222
|
countryCode?: string | undefined;
|
|
5085
5223
|
}
|
|
5086
5224
|
/** Totals for the invoice */
|
|
5087
5225
|
export declare class InvoiceTotals implements IInvoiceTotals {
|
|
5088
|
-
/**
|
|
5226
|
+
/** BT-106
|
|
5227
|
+
Sum of all invoice items in net.
|
|
5089
5228
|
BT-106 in XRechnung. */
|
|
5090
5229
|
totalNet?: number | undefined;
|
|
5091
|
-
/**
|
|
5230
|
+
/** BT-107
|
|
5231
|
+
This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
|
|
5092
5232
|
BT-107 in XRechnung. */
|
|
5093
5233
|
totalAllowances?: number | undefined;
|
|
5094
|
-
/**
|
|
5234
|
+
/** BT-108
|
|
5235
|
+
This is the sum of all charges in the invoice, except VAT. For example, late
|
|
5095
5236
|
fees or surcharges.
|
|
5096
5237
|
BT-108 in XRechnung. */
|
|
5097
5238
|
totalCharges?: number | undefined;
|
|
5098
|
-
/**
|
|
5239
|
+
/** BT-109
|
|
5240
|
+
This is the total net value of the invoice after applied allowances and charges,
|
|
5099
5241
|
meaning the actual net sum to be paid.
|
|
5100
5242
|
BT-109 in XRechnung. */
|
|
5101
5243
|
totalAfterDeductions?: number | undefined;
|
|
5102
|
-
/**
|
|
5244
|
+
/** BT-110
|
|
5245
|
+
The total amount of VAT in the invoice.
|
|
5103
5246
|
BT-110 in XRechnung. */
|
|
5104
5247
|
totalVatAmount?: number | undefined;
|
|
5105
|
-
/**
|
|
5248
|
+
/** BT-112
|
|
5249
|
+
The total gross amount of the invoice, including all taxes and deductions.
|
|
5106
5250
|
BT-112 in XRechnung. */
|
|
5107
5251
|
totalGross?: number | undefined;
|
|
5108
|
-
/**
|
|
5252
|
+
/** BT-113
|
|
5253
|
+
The total amount that has already been paid for this invoice, e.g. used when
|
|
5109
5254
|
previous invoice sums are included here that have already been paid.
|
|
5110
5255
|
BT-113 in XRechnung. */
|
|
5111
5256
|
alreadyPaidTotal?: number | undefined;
|
|
5112
|
-
/**
|
|
5257
|
+
/** BT-114
|
|
5258
|
+
If this is given, this specifies if any rounding amount is applied to the invoice,
|
|
5113
5259
|
before calculating the TotalToBePaid value.
|
|
5114
5260
|
BT-114 in XRechnung. */
|
|
5115
5261
|
payableRoundingAmount?: number | undefined;
|
|
5116
|
-
/**
|
|
5262
|
+
/** BT-115
|
|
5263
|
+
The sum that needs to be paid for this invoice. This is the total gross amount
|
|
5117
5264
|
minus the already paid amount.
|
|
5118
5265
|
BT-115 in XRechnung. */
|
|
5119
5266
|
totalToBePaid?: number | undefined;
|
|
@@ -5124,44 +5271,55 @@ BT-115 in XRechnung. */
|
|
|
5124
5271
|
}
|
|
5125
5272
|
/** Totals for the invoice */
|
|
5126
5273
|
export interface IInvoiceTotals {
|
|
5127
|
-
/**
|
|
5274
|
+
/** BT-106
|
|
5275
|
+
Sum of all invoice items in net.
|
|
5128
5276
|
BT-106 in XRechnung. */
|
|
5129
5277
|
totalNet?: number | undefined;
|
|
5130
|
-
/**
|
|
5278
|
+
/** BT-107
|
|
5279
|
+
This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice
|
|
5131
5280
|
BT-107 in XRechnung. */
|
|
5132
5281
|
totalAllowances?: number | undefined;
|
|
5133
|
-
/**
|
|
5282
|
+
/** BT-108
|
|
5283
|
+
This is the sum of all charges in the invoice, except VAT. For example, late
|
|
5134
5284
|
fees or surcharges.
|
|
5135
5285
|
BT-108 in XRechnung. */
|
|
5136
5286
|
totalCharges?: number | undefined;
|
|
5137
|
-
/**
|
|
5287
|
+
/** BT-109
|
|
5288
|
+
This is the total net value of the invoice after applied allowances and charges,
|
|
5138
5289
|
meaning the actual net sum to be paid.
|
|
5139
5290
|
BT-109 in XRechnung. */
|
|
5140
5291
|
totalAfterDeductions?: number | undefined;
|
|
5141
|
-
/**
|
|
5292
|
+
/** BT-110
|
|
5293
|
+
The total amount of VAT in the invoice.
|
|
5142
5294
|
BT-110 in XRechnung. */
|
|
5143
5295
|
totalVatAmount?: number | undefined;
|
|
5144
|
-
/**
|
|
5296
|
+
/** BT-112
|
|
5297
|
+
The total gross amount of the invoice, including all taxes and deductions.
|
|
5145
5298
|
BT-112 in XRechnung. */
|
|
5146
5299
|
totalGross?: number | undefined;
|
|
5147
|
-
/**
|
|
5300
|
+
/** BT-113
|
|
5301
|
+
The total amount that has already been paid for this invoice, e.g. used when
|
|
5148
5302
|
previous invoice sums are included here that have already been paid.
|
|
5149
5303
|
BT-113 in XRechnung. */
|
|
5150
5304
|
alreadyPaidTotal?: number | undefined;
|
|
5151
|
-
/**
|
|
5305
|
+
/** BT-114
|
|
5306
|
+
If this is given, this specifies if any rounding amount is applied to the invoice,
|
|
5152
5307
|
before calculating the TotalToBePaid value.
|
|
5153
5308
|
BT-114 in XRechnung. */
|
|
5154
5309
|
payableRoundingAmount?: number | undefined;
|
|
5155
|
-
/**
|
|
5310
|
+
/** BT-115
|
|
5311
|
+
The sum that needs to be paid for this invoice. This is the total gross amount
|
|
5156
5312
|
minus the already paid amount.
|
|
5157
5313
|
BT-115 in XRechnung. */
|
|
5158
5314
|
totalToBePaid?: number | undefined;
|
|
5159
5315
|
}
|
|
5160
5316
|
/** Instructions how payment for an invoice should be provided. */
|
|
5161
5317
|
export declare class PaymentInstructions implements IPaymentInstructions {
|
|
5162
|
-
/**
|
|
5318
|
+
/** BT-82
|
|
5319
|
+
Additional text to describe the payment instructions. */
|
|
5163
5320
|
description?: string | undefined;
|
|
5164
|
-
/**
|
|
5321
|
+
/** BT-81
|
|
5322
|
+
This should be a code according to UNCL 4461
|
|
5165
5323
|
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
5166
5324
|
and code "30" means non-SEPA Credit Transfer.
|
|
5167
5325
|
See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
|
|
@@ -5169,11 +5327,13 @@ See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
|
|
|
5169
5327
|
/** This should be a type according to UNCL 4461
|
|
5170
5328
|
to identify the type of payment. */
|
|
5171
5329
|
paymentType?: PaymentType | undefined;
|
|
5172
|
-
/**
|
|
5330
|
+
/** BT-90
|
|
5331
|
+
If a SEPA direct debit payment mean is used, then this reference should be provided.
|
|
5173
5332
|
It's the creditor identifier in SEPA, in German "Gläubiger-Identifikationsnummer".
|
|
5174
5333
|
Field BT-90 in XRechnung. */
|
|
5175
5334
|
paymentCreditorIdentifier?: string | undefined;
|
|
5176
|
-
/**
|
|
5335
|
+
/** BG-16
|
|
5336
|
+
A list of payment means that can be used to pay the invoice. */
|
|
5177
5337
|
paymentMeans?: PaymentMeans[] | undefined;
|
|
5178
5338
|
constructor(data?: IPaymentInstructions);
|
|
5179
5339
|
init?(_data?: any): void;
|
|
@@ -5182,9 +5342,11 @@ Field BT-90 in XRechnung. */
|
|
|
5182
5342
|
}
|
|
5183
5343
|
/** Instructions how payment for an invoice should be provided. */
|
|
5184
5344
|
export interface IPaymentInstructions {
|
|
5185
|
-
/**
|
|
5345
|
+
/** BT-82
|
|
5346
|
+
Additional text to describe the payment instructions. */
|
|
5186
5347
|
description?: string | undefined;
|
|
5187
|
-
/**
|
|
5348
|
+
/** BT-81
|
|
5349
|
+
This should be a code according to UNCL 4461
|
|
5188
5350
|
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
5189
5351
|
and code "30" means non-SEPA Credit Transfer.
|
|
5190
5352
|
See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
|
|
@@ -5192,11 +5354,13 @@ See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/ */
|
|
|
5192
5354
|
/** This should be a type according to UNCL 4461
|
|
5193
5355
|
to identify the type of payment. */
|
|
5194
5356
|
paymentType?: PaymentType | undefined;
|
|
5195
|
-
/**
|
|
5357
|
+
/** BT-90
|
|
5358
|
+
If a SEPA direct debit payment mean is used, then this reference should be provided.
|
|
5196
5359
|
It's the creditor identifier in SEPA, in German "Gläubiger-Identifikationsnummer".
|
|
5197
5360
|
Field BT-90 in XRechnung. */
|
|
5198
5361
|
paymentCreditorIdentifier?: string | undefined;
|
|
5199
|
-
/**
|
|
5362
|
+
/** BG-16
|
|
5363
|
+
A list of payment means that can be used to pay the invoice. */
|
|
5200
5364
|
paymentMeans?: IPaymentMeans[] | undefined;
|
|
5201
5365
|
}
|
|
5202
5366
|
/** 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/ */
|
|
@@ -5287,31 +5451,39 @@ export declare enum PaymentType {
|
|
|
5287
5451
|
}
|
|
5288
5452
|
/** Represents a payment means for an invoice */
|
|
5289
5453
|
export declare class PaymentMeans implements IPaymentMeans {
|
|
5290
|
-
/**
|
|
5454
|
+
/** BT-84
|
|
5455
|
+
This is typically the IBAN or account number
|
|
5291
5456
|
BT-84 in XRechnung. */
|
|
5292
5457
|
accountIdentifier?: string | undefined;
|
|
5293
|
-
/**
|
|
5458
|
+
/** BT-85
|
|
5459
|
+
The name for the account, typically the name of the owner for
|
|
5294
5460
|
a bank account.
|
|
5295
5461
|
BT-85 in XRechnung. */
|
|
5296
5462
|
accountName?: string | undefined;
|
|
5297
|
-
/**
|
|
5463
|
+
/** BT-86
|
|
5464
|
+
This can be the BIC
|
|
5298
5465
|
BT-86 in XRechnung. This will be saved in BG-17. */
|
|
5299
5466
|
serviceProviderIdentifier?: string | undefined;
|
|
5300
|
-
/**
|
|
5467
|
+
/** BT-89
|
|
5468
|
+
If used, this is the mandate id for direct debit under which
|
|
5301
5469
|
the direct debit will be performed
|
|
5302
5470
|
BT-89 in XRechnung. This will be saved in BG-19. */
|
|
5303
5471
|
directDebitMandateId?: string | undefined;
|
|
5304
|
-
/**
|
|
5472
|
+
/** BT-91
|
|
5473
|
+
If used, this is the IBAN for direct debit
|
|
5305
5474
|
BT-91 in XRechnung. */
|
|
5306
5475
|
directDebitIban?: string | undefined;
|
|
5307
|
-
/**
|
|
5476
|
+
/** BT-83
|
|
5477
|
+
The payment id, e.g. a reference number for the payment. In German,
|
|
5308
5478
|
this would be called "Verwendungszweck".
|
|
5309
5479
|
BT-83 in XRechnung. */
|
|
5310
5480
|
paymentId?: string | undefined;
|
|
5311
|
-
/**
|
|
5481
|
+
/** BT-88
|
|
5482
|
+
If this is a card payment, then this is the name of the cardholder.
|
|
5312
5483
|
BT-88 in XRechnung. */
|
|
5313
5484
|
paymentCardHolderName?: string | undefined;
|
|
5314
|
-
/**
|
|
5485
|
+
/** BT-87
|
|
5486
|
+
If this is a card payment, then this is the type of card.
|
|
5315
5487
|
BT-87 in XRechnung. This will be saved in BG-18. */
|
|
5316
5488
|
paymentCardPrimaryAccountNumber?: string | undefined;
|
|
5317
5489
|
/** If this is a card payment, then this is the type of card.
|
|
@@ -5325,31 +5497,39 @@ https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
|
|
|
5325
5497
|
}
|
|
5326
5498
|
/** Represents a payment means for an invoice */
|
|
5327
5499
|
export interface IPaymentMeans {
|
|
5328
|
-
/**
|
|
5500
|
+
/** BT-84
|
|
5501
|
+
This is typically the IBAN or account number
|
|
5329
5502
|
BT-84 in XRechnung. */
|
|
5330
5503
|
accountIdentifier?: string | undefined;
|
|
5331
|
-
/**
|
|
5504
|
+
/** BT-85
|
|
5505
|
+
The name for the account, typically the name of the owner for
|
|
5332
5506
|
a bank account.
|
|
5333
5507
|
BT-85 in XRechnung. */
|
|
5334
5508
|
accountName?: string | undefined;
|
|
5335
|
-
/**
|
|
5509
|
+
/** BT-86
|
|
5510
|
+
This can be the BIC
|
|
5336
5511
|
BT-86 in XRechnung. This will be saved in BG-17. */
|
|
5337
5512
|
serviceProviderIdentifier?: string | undefined;
|
|
5338
|
-
/**
|
|
5513
|
+
/** BT-89
|
|
5514
|
+
If used, this is the mandate id for direct debit under which
|
|
5339
5515
|
the direct debit will be performed
|
|
5340
5516
|
BT-89 in XRechnung. This will be saved in BG-19. */
|
|
5341
5517
|
directDebitMandateId?: string | undefined;
|
|
5342
|
-
/**
|
|
5518
|
+
/** BT-91
|
|
5519
|
+
If used, this is the IBAN for direct debit
|
|
5343
5520
|
BT-91 in XRechnung. */
|
|
5344
5521
|
directDebitIban?: string | undefined;
|
|
5345
|
-
/**
|
|
5522
|
+
/** BT-83
|
|
5523
|
+
The payment id, e.g. a reference number for the payment. In German,
|
|
5346
5524
|
this would be called "Verwendungszweck".
|
|
5347
5525
|
BT-83 in XRechnung. */
|
|
5348
5526
|
paymentId?: string | undefined;
|
|
5349
|
-
/**
|
|
5527
|
+
/** BT-88
|
|
5528
|
+
If this is a card payment, then this is the name of the cardholder.
|
|
5350
5529
|
BT-88 in XRechnung. */
|
|
5351
5530
|
paymentCardHolderName?: string | undefined;
|
|
5352
|
-
/**
|
|
5531
|
+
/** BT-87
|
|
5532
|
+
If this is a card payment, then this is the type of card.
|
|
5353
5533
|
BT-87 in XRechnung. This will be saved in BG-18. */
|
|
5354
5534
|
paymentCardPrimaryAccountNumber?: string | undefined;
|
|
5355
5535
|
/** If this is a card payment, then this is the type of card.
|
|
@@ -5359,17 +5539,23 @@ https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53 */
|
|
|
5359
5539
|
}
|
|
5360
5540
|
/** Represents a document / attachment that is included with the invoice */
|
|
5361
5541
|
export declare class SupportingDocument implements ISupportingDocument {
|
|
5362
|
-
/**
|
|
5542
|
+
/** BT-122
|
|
5543
|
+
This is typically an id or a name */
|
|
5363
5544
|
documentReference?: string | undefined;
|
|
5364
|
-
/**
|
|
5545
|
+
/** BT-123
|
|
5546
|
+
A description of the document */
|
|
5365
5547
|
description?: string | undefined;
|
|
5366
|
-
/**
|
|
5548
|
+
/** BT-124
|
|
5549
|
+
A link to the document in case this is an external reference */
|
|
5367
5550
|
externalDocumentUrl?: string | undefined;
|
|
5368
|
-
/**
|
|
5551
|
+
/** BT-125
|
|
5552
|
+
The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
|
|
5369
5553
|
documentBase64?: string | undefined;
|
|
5370
|
-
/**
|
|
5554
|
+
/** BT-125
|
|
5555
|
+
This should be present if DocumentBase64 is set. */
|
|
5371
5556
|
fileName?: string | undefined;
|
|
5372
|
-
/**
|
|
5557
|
+
/** BT-125
|
|
5558
|
+
The type of the document */
|
|
5373
5559
|
documentMimeType: AttachmentMimeType;
|
|
5374
5560
|
/** 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
|
|
5375
5561
|
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
|
|
@@ -5383,17 +5569,23 @@ the placeholder with the actual Base64 contents of the file in this library, or
|
|
|
5383
5569
|
}
|
|
5384
5570
|
/** Represents a document / attachment that is included with the invoice */
|
|
5385
5571
|
export interface ISupportingDocument {
|
|
5386
|
-
/**
|
|
5572
|
+
/** BT-122
|
|
5573
|
+
This is typically an id or a name */
|
|
5387
5574
|
documentReference?: string | undefined;
|
|
5388
|
-
/**
|
|
5575
|
+
/** BT-123
|
|
5576
|
+
A description of the document */
|
|
5389
5577
|
description?: string | undefined;
|
|
5390
|
-
/**
|
|
5578
|
+
/** BT-124
|
|
5579
|
+
A link to the document in case this is an external reference */
|
|
5391
5580
|
externalDocumentUrl?: string | undefined;
|
|
5392
|
-
/**
|
|
5581
|
+
/** BT-125
|
|
5582
|
+
The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId. */
|
|
5393
5583
|
documentBase64?: string | undefined;
|
|
5394
|
-
/**
|
|
5584
|
+
/** BT-125
|
|
5585
|
+
This should be present if DocumentBase64 is set. */
|
|
5395
5586
|
fileName?: string | undefined;
|
|
5396
|
-
/**
|
|
5587
|
+
/** BT-125
|
|
5588
|
+
The type of the document */
|
|
5397
5589
|
documentMimeType: AttachmentMimeType;
|
|
5398
5590
|
/** 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
|
|
5399
5591
|
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
|
|
@@ -5413,20 +5605,26 @@ export declare enum AttachmentMimeType {
|
|
|
5413
5605
|
}
|
|
5414
5606
|
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
5415
5607
|
export declare class VatBreakdown implements IVatBreakdown {
|
|
5416
|
-
/**
|
|
5608
|
+
/** BT-116
|
|
5609
|
+
The total net amount of this VAT category */
|
|
5417
5610
|
netTaxableAmount?: number | undefined;
|
|
5418
|
-
/**
|
|
5611
|
+
/** BT-117
|
|
5612
|
+
The total VAT */
|
|
5419
5613
|
vatAmount?: number | undefined;
|
|
5420
|
-
/**
|
|
5614
|
+
/** BT-118
|
|
5615
|
+
The category of the VAT */
|
|
5421
5616
|
vatCategory: VatCategory;
|
|
5422
|
-
/**
|
|
5617
|
+
/** BT-119
|
|
5618
|
+
The actual tax rate as a decimal value,
|
|
5423
5619
|
e.g. 19% would be 0.19 */
|
|
5424
5620
|
taxRate?: number | undefined;
|
|
5425
|
-
/**
|
|
5621
|
+
/** BT-120
|
|
5622
|
+
If the VAT is exempt, there should be a description here.
|
|
5426
5623
|
For example, in reverse charge scenarios, this text
|
|
5427
5624
|
should contain a reference to "Reverse charge according to ...". */
|
|
5428
5625
|
vatExemptionReasonText?: string | undefined;
|
|
5429
|
-
/**
|
|
5626
|
+
/** BT-121
|
|
5627
|
+
A code from the VAT exemption reason code list(VATEX)“ */
|
|
5430
5628
|
vatExemptionReasonCode?: string | undefined;
|
|
5431
5629
|
constructor(data?: IVatBreakdown);
|
|
5432
5630
|
init?(_data?: any): void;
|
|
@@ -5435,20 +5633,26 @@ should contain a reference to "Reverse charge according to ...". */
|
|
|
5435
5633
|
}
|
|
5436
5634
|
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
5437
5635
|
export interface IVatBreakdown {
|
|
5438
|
-
/**
|
|
5636
|
+
/** BT-116
|
|
5637
|
+
The total net amount of this VAT category */
|
|
5439
5638
|
netTaxableAmount?: number | undefined;
|
|
5440
|
-
/**
|
|
5639
|
+
/** BT-117
|
|
5640
|
+
The total VAT */
|
|
5441
5641
|
vatAmount?: number | undefined;
|
|
5442
|
-
/**
|
|
5642
|
+
/** BT-118
|
|
5643
|
+
The category of the VAT */
|
|
5443
5644
|
vatCategory: VatCategory;
|
|
5444
|
-
/**
|
|
5645
|
+
/** BT-119
|
|
5646
|
+
The actual tax rate as a decimal value,
|
|
5445
5647
|
e.g. 19% would be 0.19 */
|
|
5446
5648
|
taxRate?: number | undefined;
|
|
5447
|
-
/**
|
|
5649
|
+
/** BT-120
|
|
5650
|
+
If the VAT is exempt, there should be a description here.
|
|
5448
5651
|
For example, in reverse charge scenarios, this text
|
|
5449
5652
|
should contain a reference to "Reverse charge according to ...". */
|
|
5450
5653
|
vatExemptionReasonText?: string | undefined;
|
|
5451
|
-
/**
|
|
5654
|
+
/** BT-121
|
|
5655
|
+
A code from the VAT exemption reason code list(VATEX)“ */
|
|
5452
5656
|
vatExemptionReasonCode?: string | undefined;
|
|
5453
5657
|
}
|
|
5454
5658
|
/** The category used in a VatBreakdown"/> */
|
|
@@ -5466,23 +5670,30 @@ export declare enum VatCategory {
|
|
|
5466
5670
|
}
|
|
5467
5671
|
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
5468
5672
|
export declare class InvoiceAllowance implements IInvoiceAllowance {
|
|
5469
|
-
/**
|
|
5673
|
+
/** BT-92
|
|
5674
|
+
The net amount of the allowance */
|
|
5470
5675
|
netAmount?: number | undefined;
|
|
5471
|
-
/**
|
|
5676
|
+
/** BT-93
|
|
5677
|
+
If this is a relative / percentage allowance, this should be set
|
|
5472
5678
|
and give the base amount that is being used for the calculation */
|
|
5473
5679
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
5474
|
-
/**
|
|
5680
|
+
/** BT-94
|
|
5681
|
+
If this is a relative / percentage allowance, this should be set
|
|
5475
5682
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5476
5683
|
relativeAllowancePercentage?: number | undefined;
|
|
5477
|
-
/**
|
|
5684
|
+
/** BT-95
|
|
5685
|
+
The VAT category for the allowance */
|
|
5478
5686
|
vatCategory: VatCategory;
|
|
5479
|
-
/**
|
|
5687
|
+
/** BT-96
|
|
5688
|
+
The actual tax rate as a decimal value,
|
|
5480
5689
|
meaning 19% would be 0.19 */
|
|
5481
5690
|
vatRate?: number | undefined;
|
|
5482
|
-
/**
|
|
5691
|
+
/** BT-97
|
|
5692
|
+
A description of the allowance. This should not be set it ReasonCode
|
|
5483
5693
|
is provided, otherwise this one takes precedence. */
|
|
5484
5694
|
reason?: string | undefined;
|
|
5485
|
-
/**
|
|
5695
|
+
/** BT-98
|
|
5696
|
+
A reason code for the allowance according to UNTDID 5189.
|
|
5486
5697
|
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
5487
5698
|
reasonCode?: string | undefined;
|
|
5488
5699
|
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
@@ -5495,23 +5706,30 @@ and is a read-only property. */
|
|
|
5495
5706
|
}
|
|
5496
5707
|
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
5497
5708
|
export interface IInvoiceAllowance {
|
|
5498
|
-
/**
|
|
5709
|
+
/** BT-92
|
|
5710
|
+
The net amount of the allowance */
|
|
5499
5711
|
netAmount?: number | undefined;
|
|
5500
|
-
/**
|
|
5712
|
+
/** BT-93
|
|
5713
|
+
If this is a relative / percentage allowance, this should be set
|
|
5501
5714
|
and give the base amount that is being used for the calculation */
|
|
5502
5715
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
5503
|
-
/**
|
|
5716
|
+
/** BT-94
|
|
5717
|
+
If this is a relative / percentage allowance, this should be set
|
|
5504
5718
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5505
5719
|
relativeAllowancePercentage?: number | undefined;
|
|
5506
|
-
/**
|
|
5720
|
+
/** BT-95
|
|
5721
|
+
The VAT category for the allowance */
|
|
5507
5722
|
vatCategory: VatCategory;
|
|
5508
|
-
/**
|
|
5723
|
+
/** BT-96
|
|
5724
|
+
The actual tax rate as a decimal value,
|
|
5509
5725
|
meaning 19% would be 0.19 */
|
|
5510
5726
|
vatRate?: number | undefined;
|
|
5511
|
-
/**
|
|
5727
|
+
/** BT-97
|
|
5728
|
+
A description of the allowance. This should not be set it ReasonCode
|
|
5512
5729
|
is provided, otherwise this one takes precedence. */
|
|
5513
5730
|
reason?: string | undefined;
|
|
5514
|
-
/**
|
|
5731
|
+
/** BT-98
|
|
5732
|
+
A reason code for the allowance according to UNTDID 5189.
|
|
5515
5733
|
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
5516
5734
|
reasonCode?: string | undefined;
|
|
5517
5735
|
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
@@ -5627,23 +5845,30 @@ export declare enum AllowanceReasonType {
|
|
|
5627
5845
|
}
|
|
5628
5846
|
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
5629
5847
|
export declare class InvoiceCharge implements IInvoiceCharge {
|
|
5630
|
-
/**
|
|
5848
|
+
/** BT-99
|
|
5849
|
+
The net amount of the charge */
|
|
5631
5850
|
netAmount?: number | undefined;
|
|
5632
|
-
/**
|
|
5851
|
+
/** BT-100
|
|
5852
|
+
If this is a relative / percentage charge, this should be set
|
|
5633
5853
|
and give the base amount that is being used for the calculation */
|
|
5634
5854
|
relativeChargeBaseAmount?: number | undefined;
|
|
5635
|
-
/**
|
|
5855
|
+
/** BT-101
|
|
5856
|
+
If this is a relative / percentage charge, this should be set
|
|
5636
5857
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5637
5858
|
relativeChargePercentage?: number | undefined;
|
|
5638
|
-
/**
|
|
5859
|
+
/** BT-102
|
|
5860
|
+
The VAT category for the charge */
|
|
5639
5861
|
vatCategory: VatCategory;
|
|
5640
|
-
/**
|
|
5862
|
+
/** BT-103
|
|
5863
|
+
The actual tax rate as a decimal value,
|
|
5641
5864
|
meaning 19% would be 0.19 */
|
|
5642
5865
|
vatRate?: number | undefined;
|
|
5643
|
-
/**
|
|
5866
|
+
/** BT-104
|
|
5867
|
+
A description of the charge. This should not be set it ReasonCode
|
|
5644
5868
|
is provided, otherwise this one takes precedence. */
|
|
5645
5869
|
reason?: string | undefined;
|
|
5646
|
-
/**
|
|
5870
|
+
/** BT-105
|
|
5871
|
+
A reason code for the charge according to UNTDID 7161.
|
|
5647
5872
|
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
5648
5873
|
reasonCode?: string | undefined;
|
|
5649
5874
|
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
@@ -5656,23 +5881,30 @@ and is a read-only property. */
|
|
|
5656
5881
|
}
|
|
5657
5882
|
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
5658
5883
|
export interface IInvoiceCharge {
|
|
5659
|
-
/**
|
|
5884
|
+
/** BT-99
|
|
5885
|
+
The net amount of the charge */
|
|
5660
5886
|
netAmount?: number | undefined;
|
|
5661
|
-
/**
|
|
5887
|
+
/** BT-100
|
|
5888
|
+
If this is a relative / percentage charge, this should be set
|
|
5662
5889
|
and give the base amount that is being used for the calculation */
|
|
5663
5890
|
relativeChargeBaseAmount?: number | undefined;
|
|
5664
|
-
/**
|
|
5891
|
+
/** BT-101
|
|
5892
|
+
If this is a relative / percentage charge, this should be set
|
|
5665
5893
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5666
5894
|
relativeChargePercentage?: number | undefined;
|
|
5667
|
-
/**
|
|
5895
|
+
/** BT-102
|
|
5896
|
+
The VAT category for the charge */
|
|
5668
5897
|
vatCategory: VatCategory;
|
|
5669
|
-
/**
|
|
5898
|
+
/** BT-103
|
|
5899
|
+
The actual tax rate as a decimal value,
|
|
5670
5900
|
meaning 19% would be 0.19 */
|
|
5671
5901
|
vatRate?: number | undefined;
|
|
5672
|
-
/**
|
|
5902
|
+
/** BT-104
|
|
5903
|
+
A description of the charge. This should not be set it ReasonCode
|
|
5673
5904
|
is provided, otherwise this one takes precedence. */
|
|
5674
5905
|
reason?: string | undefined;
|
|
5675
|
-
/**
|
|
5906
|
+
/** BT-105
|
|
5907
|
+
A reason code for the charge according to UNTDID 7161.
|
|
5676
5908
|
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
5677
5909
|
reasonCode?: string | undefined;
|
|
5678
5910
|
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
@@ -5845,39 +6077,53 @@ export declare enum ChargeReasonType {
|
|
|
5845
6077
|
}
|
|
5846
6078
|
/** Represents a single invoice line item */
|
|
5847
6079
|
export declare class InvoiceLineItem implements IInvoiceLineItem {
|
|
5848
|
-
/**
|
|
6080
|
+
/** BT-126
|
|
6081
|
+
An unique identifier for the line item */
|
|
5849
6082
|
identifier?: string | undefined;
|
|
5850
|
-
/**
|
|
6083
|
+
/** BT-127
|
|
6084
|
+
An unstructured note to classify line items */
|
|
5851
6085
|
note?: string | undefined;
|
|
5852
|
-
/**
|
|
6086
|
+
/** BT-128
|
|
6087
|
+
A seller-defined object identifier for this line item,
|
|
5853
6088
|
meaning an identifier for the actual line. This could be
|
|
5854
6089
|
a numbering sequence or a reference to a product. */
|
|
5855
6090
|
objectIdentifier?: string | undefined;
|
|
5856
|
-
/**
|
|
6091
|
+
/** BT-129
|
|
6092
|
+
The actual invoiced quantity of the line item */
|
|
5857
6093
|
quantity?: number | undefined;
|
|
5858
|
-
/**
|
|
6094
|
+
/** BT-130
|
|
6095
|
+
A code for the unit of the quantity. This should be a code as defined
|
|
5859
6096
|
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
5860
6097
|
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
5861
6098
|
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names).
|
|
5862
6099
|
See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931 */
|
|
5863
6100
|
unitCode?: string | undefined;
|
|
5864
|
-
/**
|
|
6101
|
+
/** BT-131
|
|
6102
|
+
The net amount for this line item. This is the total price for positions */
|
|
5865
6103
|
netAmount?: number | undefined;
|
|
5866
|
-
/**
|
|
6104
|
+
/** BT-132
|
|
6105
|
+
A reference to an item in the buyers purachase order */
|
|
5867
6106
|
purchaseOrderReference?: string | undefined;
|
|
5868
|
-
/**
|
|
6107
|
+
/** BG-26
|
|
6108
|
+
Information about the invoice period for this line item. */
|
|
5869
6109
|
lineItemPeriod?: InvoicePeriod | undefined;
|
|
5870
|
-
/**
|
|
6110
|
+
/** BG-27
|
|
6111
|
+
Allowances specific to this line item */
|
|
5871
6112
|
allowances?: LineItemAllowance[] | undefined;
|
|
5872
|
-
/**
|
|
6113
|
+
/** BG-28
|
|
6114
|
+
charges specific to this line item */
|
|
5873
6115
|
charges?: LineItemCharge[] | undefined;
|
|
5874
|
-
/**
|
|
6116
|
+
/** BG-29
|
|
6117
|
+
Price details for this line item. */
|
|
5875
6118
|
priceDetails?: LineItemPriceDetail | undefined;
|
|
5876
|
-
/**
|
|
6119
|
+
/** BG-30
|
|
6120
|
+
VAT information for this line item */
|
|
5877
6121
|
vatInformation?: LineItemVatInformation[] | undefined;
|
|
5878
|
-
/**
|
|
6122
|
+
/** BG-31
|
|
6123
|
+
Information about this line item */
|
|
5879
6124
|
itemInformation?: LineItemInformation | undefined;
|
|
5880
|
-
/**
|
|
6125
|
+
/** BG-DEX-01
|
|
6126
|
+
Line items can be nested, in which case this property holds the sub items */
|
|
5881
6127
|
subItems?: InvoiceLineItem[] | undefined;
|
|
5882
6128
|
constructor(data?: IInvoiceLineItem);
|
|
5883
6129
|
init?(_data?: any): void;
|
|
@@ -5886,54 +6132,73 @@ See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Reg
|
|
|
5886
6132
|
}
|
|
5887
6133
|
/** Represents a single invoice line item */
|
|
5888
6134
|
export interface IInvoiceLineItem {
|
|
5889
|
-
/**
|
|
6135
|
+
/** BT-126
|
|
6136
|
+
An unique identifier for the line item */
|
|
5890
6137
|
identifier?: string | undefined;
|
|
5891
|
-
/**
|
|
6138
|
+
/** BT-127
|
|
6139
|
+
An unstructured note to classify line items */
|
|
5892
6140
|
note?: string | undefined;
|
|
5893
|
-
/**
|
|
6141
|
+
/** BT-128
|
|
6142
|
+
A seller-defined object identifier for this line item,
|
|
5894
6143
|
meaning an identifier for the actual line. This could be
|
|
5895
6144
|
a numbering sequence or a reference to a product. */
|
|
5896
6145
|
objectIdentifier?: string | undefined;
|
|
5897
|
-
/**
|
|
6146
|
+
/** BT-129
|
|
6147
|
+
The actual invoiced quantity of the line item */
|
|
5898
6148
|
quantity?: number | undefined;
|
|
5899
|
-
/**
|
|
6149
|
+
/** BT-130
|
|
6150
|
+
A code for the unit of the quantity. This should be a code as defined
|
|
5900
6151
|
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
5901
6152
|
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
5902
6153
|
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names).
|
|
5903
6154
|
See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931 */
|
|
5904
6155
|
unitCode?: string | undefined;
|
|
5905
|
-
/**
|
|
6156
|
+
/** BT-131
|
|
6157
|
+
The net amount for this line item. This is the total price for positions */
|
|
5906
6158
|
netAmount?: number | undefined;
|
|
5907
|
-
/**
|
|
6159
|
+
/** BT-132
|
|
6160
|
+
A reference to an item in the buyers purachase order */
|
|
5908
6161
|
purchaseOrderReference?: string | undefined;
|
|
5909
|
-
/**
|
|
6162
|
+
/** BG-26
|
|
6163
|
+
Information about the invoice period for this line item. */
|
|
5910
6164
|
lineItemPeriod?: IInvoicePeriod | undefined;
|
|
5911
|
-
/**
|
|
6165
|
+
/** BG-27
|
|
6166
|
+
Allowances specific to this line item */
|
|
5912
6167
|
allowances?: ILineItemAllowance[] | undefined;
|
|
5913
|
-
/**
|
|
6168
|
+
/** BG-28
|
|
6169
|
+
charges specific to this line item */
|
|
5914
6170
|
charges?: ILineItemCharge[] | undefined;
|
|
5915
|
-
/**
|
|
6171
|
+
/** BG-29
|
|
6172
|
+
Price details for this line item. */
|
|
5916
6173
|
priceDetails?: ILineItemPriceDetail | undefined;
|
|
5917
|
-
/**
|
|
6174
|
+
/** BG-30
|
|
6175
|
+
VAT information for this line item */
|
|
5918
6176
|
vatInformation?: ILineItemVatInformation[] | undefined;
|
|
5919
|
-
/**
|
|
6177
|
+
/** BG-31
|
|
6178
|
+
Information about this line item */
|
|
5920
6179
|
itemInformation?: ILineItemInformation | undefined;
|
|
5921
|
-
/**
|
|
6180
|
+
/** BG-DEX-01
|
|
6181
|
+
Line items can be nested, in which case this property holds the sub items */
|
|
5922
6182
|
subItems?: IInvoiceLineItem[] | undefined;
|
|
5923
6183
|
}
|
|
5924
6184
|
/** Allowance for a single line item */
|
|
5925
6185
|
export declare class LineItemAllowance implements ILineItemAllowance {
|
|
5926
|
-
/**
|
|
6186
|
+
/** BT-136
|
|
6187
|
+
The net amount of the allowance */
|
|
5927
6188
|
netAmount?: number | undefined;
|
|
5928
|
-
/**
|
|
6189
|
+
/** BT-137
|
|
6190
|
+
If this is a relative / percentage allowance, this should be set
|
|
5929
6191
|
and give the base amount that is being used for the calculation */
|
|
5930
6192
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
5931
|
-
/**
|
|
6193
|
+
/** BT-138
|
|
6194
|
+
If this is a relative / percentage allowance, this should be set
|
|
5932
6195
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5933
6196
|
relativeAllowancePercentage?: number | undefined;
|
|
5934
|
-
/**
|
|
6197
|
+
/** BT-139
|
|
6198
|
+
A description of the allowance. */
|
|
5935
6199
|
reason?: string | undefined;
|
|
5936
|
-
/**
|
|
6200
|
+
/** BT-140
|
|
6201
|
+
A reason code for the allowance according to UNTDID 5189. Should be a code
|
|
5937
6202
|
from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
5938
6203
|
reasonCode?: string | undefined;
|
|
5939
6204
|
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
@@ -5946,17 +6211,22 @@ and is a read-only property. */
|
|
|
5946
6211
|
}
|
|
5947
6212
|
/** Allowance for a single line item */
|
|
5948
6213
|
export interface ILineItemAllowance {
|
|
5949
|
-
/**
|
|
6214
|
+
/** BT-136
|
|
6215
|
+
The net amount of the allowance */
|
|
5950
6216
|
netAmount?: number | undefined;
|
|
5951
|
-
/**
|
|
6217
|
+
/** BT-137
|
|
6218
|
+
If this is a relative / percentage allowance, this should be set
|
|
5952
6219
|
and give the base amount that is being used for the calculation */
|
|
5953
6220
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
5954
|
-
/**
|
|
6221
|
+
/** BT-138
|
|
6222
|
+
If this is a relative / percentage allowance, this should be set
|
|
5955
6223
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5956
6224
|
relativeAllowancePercentage?: number | undefined;
|
|
5957
|
-
/**
|
|
6225
|
+
/** BT-139
|
|
6226
|
+
A description of the allowance. */
|
|
5958
6227
|
reason?: string | undefined;
|
|
5959
|
-
/**
|
|
6228
|
+
/** BT-140
|
|
6229
|
+
A reason code for the allowance according to UNTDID 5189. Should be a code
|
|
5960
6230
|
from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm */
|
|
5961
6231
|
reasonCode?: string | undefined;
|
|
5962
6232
|
/** A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode
|
|
@@ -5965,17 +6235,22 @@ and is a read-only property. */
|
|
|
5965
6235
|
}
|
|
5966
6236
|
/** Charge for a single line item */
|
|
5967
6237
|
export declare class LineItemCharge implements ILineItemCharge {
|
|
5968
|
-
/**
|
|
6238
|
+
/** BT-141
|
|
6239
|
+
The net amount of the charge */
|
|
5969
6240
|
netAmount?: number | undefined;
|
|
5970
|
-
/**
|
|
6241
|
+
/** BT-142
|
|
6242
|
+
If this is a relative / percentage charge, this should be set
|
|
5971
6243
|
and give the base amount that is being used for the calculation */
|
|
5972
6244
|
relativeChargeBaseAmount?: number | undefined;
|
|
5973
|
-
/**
|
|
6245
|
+
/** BT-143
|
|
6246
|
+
If this is a relative / percentage charge, this should be set
|
|
5974
6247
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5975
6248
|
relativeChargePercentage?: number | undefined;
|
|
5976
|
-
/**
|
|
6249
|
+
/** BT-144
|
|
6250
|
+
A description of the charge. */
|
|
5977
6251
|
reason?: string | undefined;
|
|
5978
|
-
/**
|
|
6252
|
+
/** BT-145
|
|
6253
|
+
A reason code for the charge according to UNTDID 7161.
|
|
5979
6254
|
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
5980
6255
|
reasonCode?: string | undefined;
|
|
5981
6256
|
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
@@ -5988,17 +6263,22 @@ and is a read-only property. */
|
|
|
5988
6263
|
}
|
|
5989
6264
|
/** Charge for a single line item */
|
|
5990
6265
|
export interface ILineItemCharge {
|
|
5991
|
-
/**
|
|
6266
|
+
/** BT-141
|
|
6267
|
+
The net amount of the charge */
|
|
5992
6268
|
netAmount?: number | undefined;
|
|
5993
|
-
/**
|
|
6269
|
+
/** BT-142
|
|
6270
|
+
If this is a relative / percentage charge, this should be set
|
|
5994
6271
|
and give the base amount that is being used for the calculation */
|
|
5995
6272
|
relativeChargeBaseAmount?: number | undefined;
|
|
5996
|
-
/**
|
|
6273
|
+
/** BT-143
|
|
6274
|
+
If this is a relative / percentage charge, this should be set
|
|
5997
6275
|
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
5998
6276
|
relativeChargePercentage?: number | undefined;
|
|
5999
|
-
/**
|
|
6277
|
+
/** BT-144
|
|
6278
|
+
A description of the charge. */
|
|
6000
6279
|
reason?: string | undefined;
|
|
6001
|
-
/**
|
|
6280
|
+
/** BT-145
|
|
6281
|
+
A reason code for the charge according to UNTDID 7161.
|
|
6002
6282
|
See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm */
|
|
6003
6283
|
reasonCode?: string | undefined;
|
|
6004
6284
|
/** A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode
|
|
@@ -6007,18 +6287,23 @@ and is a read-only property. */
|
|
|
6007
6287
|
}
|
|
6008
6288
|
/** Price details about a line item */
|
|
6009
6289
|
export declare class LineItemPriceDetail implements ILineItemPriceDetail {
|
|
6010
|
-
/**
|
|
6290
|
+
/** BT-146
|
|
6291
|
+
The net price of this line item. This is the unit price */
|
|
6011
6292
|
netPrice?: number | undefined;
|
|
6012
|
-
/**
|
|
6293
|
+
/** BT-147
|
|
6294
|
+
A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
6013
6295
|
and the actual invoiced price GrossPrice. */
|
|
6014
6296
|
absoluteDiscountPerItem?: number | undefined;
|
|
6015
|
-
/**
|
|
6297
|
+
/** BT-148
|
|
6298
|
+
The gross price of this line item, meaning the price without taxes
|
|
6016
6299
|
that will be invoiced */
|
|
6017
6300
|
grossPrice?: number | undefined;
|
|
6018
|
-
/**
|
|
6301
|
+
/** BT-149
|
|
6302
|
+
The quantity for which this price is valid. In combination with the NetPrice,
|
|
6019
6303
|
you basically specify the denominator of the unit price for a line item. */
|
|
6020
6304
|
baseQuantity?: number | undefined;
|
|
6021
|
-
/**
|
|
6305
|
+
/** BT-150
|
|
6306
|
+
A code representing the unit for the base quantity */
|
|
6022
6307
|
baseQuantityUnitCode?: string | undefined;
|
|
6023
6308
|
constructor(data?: ILineItemPriceDetail);
|
|
6024
6309
|
init?(_data?: any): void;
|
|
@@ -6027,25 +6312,32 @@ you basically specify the denominator of the unit price for a line item. */
|
|
|
6027
6312
|
}
|
|
6028
6313
|
/** Price details about a line item */
|
|
6029
6314
|
export interface ILineItemPriceDetail {
|
|
6030
|
-
/**
|
|
6315
|
+
/** BT-146
|
|
6316
|
+
The net price of this line item. This is the unit price */
|
|
6031
6317
|
netPrice?: number | undefined;
|
|
6032
|
-
/**
|
|
6318
|
+
/** BT-147
|
|
6319
|
+
A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
6033
6320
|
and the actual invoiced price GrossPrice. */
|
|
6034
6321
|
absoluteDiscountPerItem?: number | undefined;
|
|
6035
|
-
/**
|
|
6322
|
+
/** BT-148
|
|
6323
|
+
The gross price of this line item, meaning the price without taxes
|
|
6036
6324
|
that will be invoiced */
|
|
6037
6325
|
grossPrice?: number | undefined;
|
|
6038
|
-
/**
|
|
6326
|
+
/** BT-149
|
|
6327
|
+
The quantity for which this price is valid. In combination with the NetPrice,
|
|
6039
6328
|
you basically specify the denominator of the unit price for a line item. */
|
|
6040
6329
|
baseQuantity?: number | undefined;
|
|
6041
|
-
/**
|
|
6330
|
+
/** BT-150
|
|
6331
|
+
A code representing the unit for the base quantity */
|
|
6042
6332
|
baseQuantityUnitCode?: string | undefined;
|
|
6043
6333
|
}
|
|
6044
6334
|
/** VAT information for a single line item */
|
|
6045
6335
|
export declare class LineItemVatInformation implements ILineItemVatInformation {
|
|
6046
|
-
/**
|
|
6336
|
+
/** BT-151
|
|
6337
|
+
The VAT category for the charge */
|
|
6047
6338
|
vatCategory: VatCategory;
|
|
6048
|
-
/**
|
|
6339
|
+
/** BT-152
|
|
6340
|
+
The actual tax rate as a decimal value,
|
|
6049
6341
|
meaning 19% would be 0.19 */
|
|
6050
6342
|
vatRate?: number | undefined;
|
|
6051
6343
|
constructor(data?: ILineItemVatInformation);
|
|
@@ -6055,36 +6347,48 @@ meaning 19% would be 0.19 */
|
|
|
6055
6347
|
}
|
|
6056
6348
|
/** VAT information for a single line item */
|
|
6057
6349
|
export interface ILineItemVatInformation {
|
|
6058
|
-
/**
|
|
6350
|
+
/** BT-151
|
|
6351
|
+
The VAT category for the charge */
|
|
6059
6352
|
vatCategory: VatCategory;
|
|
6060
|
-
/**
|
|
6353
|
+
/** BT-152
|
|
6354
|
+
The actual tax rate as a decimal value,
|
|
6061
6355
|
meaning 19% would be 0.19 */
|
|
6062
6356
|
vatRate?: number | undefined;
|
|
6063
6357
|
}
|
|
6064
6358
|
/** Information about a single line item */
|
|
6065
6359
|
export declare class LineItemInformation implements ILineItemInformation {
|
|
6066
|
-
/**
|
|
6360
|
+
/** BT-153
|
|
6361
|
+
A name for the line item */
|
|
6067
6362
|
name?: string | undefined;
|
|
6068
|
-
/**
|
|
6363
|
+
/** BT-154
|
|
6364
|
+
A description for the line item */
|
|
6069
6365
|
description?: string | undefined;
|
|
6070
|
-
/**
|
|
6366
|
+
/** BT-155
|
|
6367
|
+
An identifier assigned by the seller, e.g. an internal article number */
|
|
6071
6368
|
sellerIdentifier?: string | undefined;
|
|
6072
|
-
/**
|
|
6369
|
+
/** BT-156
|
|
6370
|
+
An identifier assigned by the buyer, e.g. an internal article number */
|
|
6073
6371
|
buyerIdentifier?: string | undefined;
|
|
6074
|
-
/**
|
|
6372
|
+
/** BT-157
|
|
6373
|
+
A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
6075
6374
|
standardIdentifier?: string | undefined;
|
|
6076
|
-
/**
|
|
6375
|
+
/** BT-157
|
|
6376
|
+
If used together with StandardIdentifier, this is the scheme identifier
|
|
6077
6377
|
for which standard is used. */
|
|
6078
6378
|
standardSchemeId?: string | undefined;
|
|
6079
|
-
/**
|
|
6379
|
+
/** BT-158
|
|
6380
|
+
A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
|
|
6080
6381
|
classificationIdentifiers?: string[] | undefined;
|
|
6081
|
-
/**
|
|
6382
|
+
/** BT-158
|
|
6383
|
+
This is used in connection with ClassificationIdentifiers. It is the scheme identifier
|
|
6082
6384
|
for each identifier. If this list is used, it should have the same length as ClassificationIdentifiers, with null or empty values used
|
|
6083
6385
|
for non-existing scheme identifiers. */
|
|
6084
6386
|
classificationTypes?: string[] | undefined;
|
|
6085
|
-
/**
|
|
6387
|
+
/** BT-159
|
|
6388
|
+
The origin country code according to ISO 3166-1 in 2 letter format */
|
|
6086
6389
|
countryOfOrigin?: string | undefined;
|
|
6087
|
-
/**
|
|
6390
|
+
/** BG-32
|
|
6391
|
+
Optional additional attributes for this line item */
|
|
6088
6392
|
attributes?: LineItemAttribute[] | undefined;
|
|
6089
6393
|
constructor(data?: ILineItemInformation);
|
|
6090
6394
|
init?(_data?: any): void;
|
|
@@ -6093,35 +6397,47 @@ for non-existing scheme identifiers. */
|
|
|
6093
6397
|
}
|
|
6094
6398
|
/** Information about a single line item */
|
|
6095
6399
|
export interface ILineItemInformation {
|
|
6096
|
-
/**
|
|
6400
|
+
/** BT-153
|
|
6401
|
+
A name for the line item */
|
|
6097
6402
|
name?: string | undefined;
|
|
6098
|
-
/**
|
|
6403
|
+
/** BT-154
|
|
6404
|
+
A description for the line item */
|
|
6099
6405
|
description?: string | undefined;
|
|
6100
|
-
/**
|
|
6406
|
+
/** BT-155
|
|
6407
|
+
An identifier assigned by the seller, e.g. an internal article number */
|
|
6101
6408
|
sellerIdentifier?: string | undefined;
|
|
6102
|
-
/**
|
|
6409
|
+
/** BT-156
|
|
6410
|
+
An identifier assigned by the buyer, e.g. an internal article number */
|
|
6103
6411
|
buyerIdentifier?: string | undefined;
|
|
6104
|
-
/**
|
|
6412
|
+
/** BT-157
|
|
6413
|
+
A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
6105
6414
|
standardIdentifier?: string | undefined;
|
|
6106
|
-
/**
|
|
6415
|
+
/** BT-157
|
|
6416
|
+
If used together with StandardIdentifier, this is the scheme identifier
|
|
6107
6417
|
for which standard is used. */
|
|
6108
6418
|
standardSchemeId?: string | undefined;
|
|
6109
|
-
/**
|
|
6419
|
+
/** BT-158
|
|
6420
|
+
A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier. */
|
|
6110
6421
|
classificationIdentifiers?: string[] | undefined;
|
|
6111
|
-
/**
|
|
6422
|
+
/** BT-158
|
|
6423
|
+
This is used in connection with ClassificationIdentifiers. It is the scheme identifier
|
|
6112
6424
|
for each identifier. If this list is used, it should have the same length as ClassificationIdentifiers, with null or empty values used
|
|
6113
6425
|
for non-existing scheme identifiers. */
|
|
6114
6426
|
classificationTypes?: string[] | undefined;
|
|
6115
|
-
/**
|
|
6427
|
+
/** BT-159
|
|
6428
|
+
The origin country code according to ISO 3166-1 in 2 letter format */
|
|
6116
6429
|
countryOfOrigin?: string | undefined;
|
|
6117
|
-
/**
|
|
6430
|
+
/** BG-32
|
|
6431
|
+
Optional additional attributes for this line item */
|
|
6118
6432
|
attributes?: ILineItemAttribute[] | undefined;
|
|
6119
6433
|
}
|
|
6120
6434
|
/** A key-value pair for additional information */
|
|
6121
6435
|
export declare class LineItemAttribute implements ILineItemAttribute {
|
|
6122
|
-
/**
|
|
6436
|
+
/** BT-160
|
|
6437
|
+
The key / name of the attribute */
|
|
6123
6438
|
name: string;
|
|
6124
|
-
/**
|
|
6439
|
+
/** BT-161
|
|
6440
|
+
The value of the attribute */
|
|
6125
6441
|
value?: string | undefined;
|
|
6126
6442
|
constructor(data?: ILineItemAttribute);
|
|
6127
6443
|
init?(_data?: any): void;
|
|
@@ -6130,9 +6446,11 @@ export declare class LineItemAttribute implements ILineItemAttribute {
|
|
|
6130
6446
|
}
|
|
6131
6447
|
/** A key-value pair for additional information */
|
|
6132
6448
|
export interface ILineItemAttribute {
|
|
6133
|
-
/**
|
|
6449
|
+
/** BT-160
|
|
6450
|
+
The key / name of the attribute */
|
|
6134
6451
|
name: string;
|
|
6135
|
-
/**
|
|
6452
|
+
/** BT-161
|
|
6453
|
+
The value of the attribute */
|
|
6136
6454
|
value?: string | undefined;
|
|
6137
6455
|
}
|
|
6138
6456
|
/** This enum represents the source of an invoice, e.g. from which format it was imported */
|