@dangl/avacloud-client-node 1.30.0-beta0002 → 1.31.0-beta0001
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 +406 -2
- package/api.js +30 -2
- package/api.js.map +1 -1
- package/api.ts +410 -4
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -6526,6 +6526,8 @@ export class ItemNumberSchemaDto implements IItemNumberSchemaDto {
|
|
|
6526
6526
|
readonly schemaIsCorrectlyDefined!: boolean;
|
|
6527
6527
|
/** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
|
|
6528
6528
|
allowUpperCaseLettering!: boolean;
|
|
6529
|
+
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
6530
|
+
disableLeftPaddingTiersWithFiller!: boolean;
|
|
6529
6531
|
|
|
6530
6532
|
constructor(data?: IItemNumberSchemaDto) {
|
|
6531
6533
|
if (data) {
|
|
@@ -6558,6 +6560,7 @@ export class ItemNumberSchemaDto implements IItemNumberSchemaDto {
|
|
|
6558
6560
|
this.skippedTiersFiller = _data["skippedTiersFiller"];
|
|
6559
6561
|
(<any>this).schemaIsCorrectlyDefined = _data["schemaIsCorrectlyDefined"];
|
|
6560
6562
|
this.allowUpperCaseLettering = _data["allowUpperCaseLettering"];
|
|
6563
|
+
this.disableLeftPaddingTiersWithFiller = _data["disableLeftPaddingTiersWithFiller"];
|
|
6561
6564
|
}
|
|
6562
6565
|
}
|
|
6563
6566
|
|
|
@@ -6583,6 +6586,7 @@ export class ItemNumberSchemaDto implements IItemNumberSchemaDto {
|
|
|
6583
6586
|
data["skippedTiersFiller"] = this.skippedTiersFiller;
|
|
6584
6587
|
data["schemaIsCorrectlyDefined"] = this.schemaIsCorrectlyDefined;
|
|
6585
6588
|
data["allowUpperCaseLettering"] = this.allowUpperCaseLettering;
|
|
6589
|
+
data["disableLeftPaddingTiersWithFiller"] = this.disableLeftPaddingTiersWithFiller;
|
|
6586
6590
|
return data;
|
|
6587
6591
|
}
|
|
6588
6592
|
}
|
|
@@ -6607,6 +6611,8 @@ export interface IItemNumberSchemaDto {
|
|
|
6607
6611
|
schemaIsCorrectlyDefined: boolean;
|
|
6608
6612
|
/** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
|
|
6609
6613
|
allowUpperCaseLettering: boolean;
|
|
6614
|
+
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
6615
|
+
disableLeftPaddingTiersWithFiller: boolean;
|
|
6610
6616
|
}
|
|
6611
6617
|
|
|
6612
6618
|
/** Represents information about a single Tier in an ItemNumber. */
|
|
@@ -11153,27 +11159,51 @@ reasons. */
|
|
|
11153
11159
|
treatNullItemNumberSchemaAsInvalid: boolean;
|
|
11154
11160
|
}
|
|
11155
11161
|
|
|
11162
|
+
/** This class represents an invoice */
|
|
11156
11163
|
export class Invoice implements IInvoice {
|
|
11164
|
+
/** The number of the invoice */
|
|
11157
11165
|
invoiceNumber?: string | undefined;
|
|
11166
|
+
/** The date of the invoice */
|
|
11158
11167
|
invoiceDate?: Date | undefined;
|
|
11168
|
+
/** The type of the invoice */
|
|
11159
11169
|
invoiceType?: InvoiceType | undefined;
|
|
11170
|
+
/** The three letter ISO currency code */
|
|
11160
11171
|
currencyCode?: string | undefined;
|
|
11172
|
+
/** Until when the payment is due */
|
|
11161
11173
|
paymentDueDate?: Date | undefined;
|
|
11174
|
+
/** An object holding reference used in this invoice */
|
|
11162
11175
|
references?: References | undefined;
|
|
11176
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
11163
11177
|
paymentTerms?: string | undefined;
|
|
11178
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
11164
11179
|
previousInvoices?: PreviousInvoice[] | undefined;
|
|
11180
|
+
/** Information about the buyer */
|
|
11165
11181
|
buyer?: Organization | undefined;
|
|
11182
|
+
/** Information about the seller */
|
|
11166
11183
|
seller?: Organization | undefined;
|
|
11184
|
+
/** A payee is someone who receives the payment that is different from the seller */
|
|
11167
11185
|
payee?: Payee | undefined;
|
|
11186
|
+
/** If present, this is an unstructured text that can be used to give additional information
|
|
11187
|
+
about the invoice. */
|
|
11168
11188
|
invoiceNotes?: InvoiceNote[] | undefined;
|
|
11189
|
+
/** The period during which the services or goods were delivered */
|
|
11169
11190
|
invoicePeriod?: InvoicePeriod | undefined;
|
|
11191
|
+
/** Totals for the invoice */
|
|
11170
11192
|
totals?: InvoiceTotals | undefined;
|
|
11193
|
+
/** Instructions how to perform the payment */
|
|
11171
11194
|
paymentInstructions?: PaymentInstructions | undefined;
|
|
11195
|
+
/** Attached documents to the invoice */
|
|
11172
11196
|
documents?: SupportingDocument[] | undefined;
|
|
11197
|
+
/** This is used to list VAT by category, e.g. for invoices
|
|
11198
|
+
where parts are in different VAT categories */
|
|
11173
11199
|
vatBreakdown?: VatBreakdown[] | undefined;
|
|
11200
|
+
/** Allowances / deductions on the invoice */
|
|
11174
11201
|
allowances?: InvoiceAllowance[] | undefined;
|
|
11202
|
+
/** Charges / additional costs on the invoice */
|
|
11175
11203
|
charges?: InvoiceCharge[] | undefined;
|
|
11204
|
+
/** Single line items in the invoice */
|
|
11176
11205
|
lineItems?: InvoiceLineItem[] | undefined;
|
|
11206
|
+
/** The source type from which the invoice was created */
|
|
11177
11207
|
sourceType!: SourceType;
|
|
11178
11208
|
|
|
11179
11209
|
constructor(data?: IInvoice) {
|
|
@@ -11357,30 +11387,55 @@ export class Invoice implements IInvoice {
|
|
|
11357
11387
|
}
|
|
11358
11388
|
}
|
|
11359
11389
|
|
|
11390
|
+
/** This class represents an invoice */
|
|
11360
11391
|
export interface IInvoice {
|
|
11392
|
+
/** The number of the invoice */
|
|
11361
11393
|
invoiceNumber?: string | undefined;
|
|
11394
|
+
/** The date of the invoice */
|
|
11362
11395
|
invoiceDate?: Date | undefined;
|
|
11396
|
+
/** The type of the invoice */
|
|
11363
11397
|
invoiceType?: InvoiceType | undefined;
|
|
11398
|
+
/** The three letter ISO currency code */
|
|
11364
11399
|
currencyCode?: string | undefined;
|
|
11400
|
+
/** Until when the payment is due */
|
|
11365
11401
|
paymentDueDate?: Date | undefined;
|
|
11402
|
+
/** An object holding reference used in this invoice */
|
|
11366
11403
|
references?: IReferences | undefined;
|
|
11404
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
11367
11405
|
paymentTerms?: string | undefined;
|
|
11406
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
11368
11407
|
previousInvoices?: IPreviousInvoice[] | undefined;
|
|
11408
|
+
/** Information about the buyer */
|
|
11369
11409
|
buyer?: IOrganization | undefined;
|
|
11410
|
+
/** Information about the seller */
|
|
11370
11411
|
seller?: IOrganization | undefined;
|
|
11412
|
+
/** A payee is someone who receives the payment that is different from the seller */
|
|
11371
11413
|
payee?: IPayee | undefined;
|
|
11414
|
+
/** If present, this is an unstructured text that can be used to give additional information
|
|
11415
|
+
about the invoice. */
|
|
11372
11416
|
invoiceNotes?: IInvoiceNote[] | undefined;
|
|
11417
|
+
/** The period during which the services or goods were delivered */
|
|
11373
11418
|
invoicePeriod?: IInvoicePeriod | undefined;
|
|
11419
|
+
/** Totals for the invoice */
|
|
11374
11420
|
totals?: IInvoiceTotals | undefined;
|
|
11421
|
+
/** Instructions how to perform the payment */
|
|
11375
11422
|
paymentInstructions?: IPaymentInstructions | undefined;
|
|
11423
|
+
/** Attached documents to the invoice */
|
|
11376
11424
|
documents?: ISupportingDocument[] | undefined;
|
|
11425
|
+
/** This is used to list VAT by category, e.g. for invoices
|
|
11426
|
+
where parts are in different VAT categories */
|
|
11377
11427
|
vatBreakdown?: IVatBreakdown[] | undefined;
|
|
11428
|
+
/** Allowances / deductions on the invoice */
|
|
11378
11429
|
allowances?: IInvoiceAllowance[] | undefined;
|
|
11430
|
+
/** Charges / additional costs on the invoice */
|
|
11379
11431
|
charges?: IInvoiceCharge[] | undefined;
|
|
11432
|
+
/** Single line items in the invoice */
|
|
11380
11433
|
lineItems?: IInvoiceLineItem[] | undefined;
|
|
11434
|
+
/** The source type from which the invoice was created */
|
|
11381
11435
|
sourceType: SourceType;
|
|
11382
11436
|
}
|
|
11383
11437
|
|
|
11438
|
+
/** Type of the invoice */
|
|
11384
11439
|
export enum InvoiceType {
|
|
11385
11440
|
PartialInvoice = "PartialInvoice",
|
|
11386
11441
|
CommercialInvoice = "CommercialInvoice",
|
|
@@ -11392,15 +11447,26 @@ export enum InvoiceType {
|
|
|
11392
11447
|
FinalConstructionInvoice = "FinalConstructionInvoice",
|
|
11393
11448
|
}
|
|
11394
11449
|
|
|
11450
|
+
/** This class holds typical references used in an invoice */
|
|
11395
11451
|
export class References implements IReferences {
|
|
11452
|
+
/** An internal reference used by the buyer */
|
|
11396
11453
|
buyerReference?: string | undefined;
|
|
11454
|
+
/** Reference to a project */
|
|
11397
11455
|
projectReference?: string | undefined;
|
|
11456
|
+
/** Reference to a contract */
|
|
11398
11457
|
contractReference?: string | undefined;
|
|
11458
|
+
/** Reference to a purchase order created by the buyer */
|
|
11399
11459
|
purchaseOrderReference?: string | undefined;
|
|
11460
|
+
/** Reference to a sales order created by the seller */
|
|
11400
11461
|
salesOrderReference?: string | undefined;
|
|
11462
|
+
/** Reference to a delivery note */
|
|
11401
11463
|
receivingAdviceReference?: string | undefined;
|
|
11464
|
+
/** Reference to a dispatch advice */
|
|
11402
11465
|
dispatchAdviceReference?: string | undefined;
|
|
11466
|
+
/** Reference to a tender or lot */
|
|
11403
11467
|
tenderOrLotReference?: string | undefined;
|
|
11468
|
+
/** Reference to a custom item, e.g. a phone number, person,
|
|
11469
|
+
contract or anything that would identify the invoice in the buyer's system */
|
|
11404
11470
|
invoicedObjectIdentifier?: string | undefined;
|
|
11405
11471
|
|
|
11406
11472
|
constructor(data?: IReferences) {
|
|
@@ -11448,20 +11514,34 @@ export class References implements IReferences {
|
|
|
11448
11514
|
}
|
|
11449
11515
|
}
|
|
11450
11516
|
|
|
11517
|
+
/** This class holds typical references used in an invoice */
|
|
11451
11518
|
export interface IReferences {
|
|
11519
|
+
/** An internal reference used by the buyer */
|
|
11452
11520
|
buyerReference?: string | undefined;
|
|
11521
|
+
/** Reference to a project */
|
|
11453
11522
|
projectReference?: string | undefined;
|
|
11523
|
+
/** Reference to a contract */
|
|
11454
11524
|
contractReference?: string | undefined;
|
|
11525
|
+
/** Reference to a purchase order created by the buyer */
|
|
11455
11526
|
purchaseOrderReference?: string | undefined;
|
|
11527
|
+
/** Reference to a sales order created by the seller */
|
|
11456
11528
|
salesOrderReference?: string | undefined;
|
|
11529
|
+
/** Reference to a delivery note */
|
|
11457
11530
|
receivingAdviceReference?: string | undefined;
|
|
11531
|
+
/** Reference to a dispatch advice */
|
|
11458
11532
|
dispatchAdviceReference?: string | undefined;
|
|
11533
|
+
/** Reference to a tender or lot */
|
|
11459
11534
|
tenderOrLotReference?: string | undefined;
|
|
11535
|
+
/** Reference to a custom item, e.g. a phone number, person,
|
|
11536
|
+
contract or anything that would identify the invoice in the buyer's system */
|
|
11460
11537
|
invoicedObjectIdentifier?: string | undefined;
|
|
11461
11538
|
}
|
|
11462
11539
|
|
|
11540
|
+
/** References to previous invoices */
|
|
11463
11541
|
export class PreviousInvoice implements IPreviousInvoice {
|
|
11542
|
+
/** The date of the previous invoice */
|
|
11464
11543
|
invoiceDate?: Date | undefined;
|
|
11544
|
+
/** The number of the previous invoice */
|
|
11465
11545
|
invoiceNumber!: string;
|
|
11466
11546
|
|
|
11467
11547
|
constructor(data?: IPreviousInvoice) {
|
|
@@ -11495,22 +11575,37 @@ export class PreviousInvoice implements IPreviousInvoice {
|
|
|
11495
11575
|
}
|
|
11496
11576
|
}
|
|
11497
11577
|
|
|
11578
|
+
/** References to previous invoices */
|
|
11498
11579
|
export interface IPreviousInvoice {
|
|
11580
|
+
/** The date of the previous invoice */
|
|
11499
11581
|
invoiceDate?: Date | undefined;
|
|
11582
|
+
/** The number of the previous invoice */
|
|
11500
11583
|
invoiceNumber: string;
|
|
11501
11584
|
}
|
|
11502
11585
|
|
|
11586
|
+
/** Represents an organization, e.g. a buyer or a seller */
|
|
11503
11587
|
export class Organization implements IOrganization {
|
|
11588
|
+
/** The name of the organization */
|
|
11504
11589
|
name?: string | undefined;
|
|
11590
|
+
/** The VAT ID for the organization */
|
|
11505
11591
|
vatId?: string | undefined;
|
|
11592
|
+
/** An email address for the organization */
|
|
11506
11593
|
email?: string | undefined;
|
|
11594
|
+
/** The name of a contact person */
|
|
11507
11595
|
contactPersonName?: string | undefined;
|
|
11596
|
+
/** The phone of a contact person */
|
|
11508
11597
|
contactPersonPhone?: string | undefined;
|
|
11598
|
+
/** The email of a contact person */
|
|
11509
11599
|
contactPersonEmail?: string | undefined;
|
|
11600
|
+
/** The address of the organization */
|
|
11510
11601
|
address?: string | undefined;
|
|
11602
|
+
/** The city of the organization */
|
|
11511
11603
|
city?: string | undefined;
|
|
11604
|
+
/** The zip code of the organization */
|
|
11512
11605
|
zipCode?: string | undefined;
|
|
11606
|
+
/** The ISO 3166-1 2 letter country code */
|
|
11513
11607
|
countryCode?: string | undefined;
|
|
11608
|
+
/** The state of the organization, e.g. a federal state in Germany */
|
|
11514
11609
|
state?: string | undefined;
|
|
11515
11610
|
|
|
11516
11611
|
constructor(data?: IOrganization) {
|
|
@@ -11562,23 +11657,40 @@ export class Organization implements IOrganization {
|
|
|
11562
11657
|
}
|
|
11563
11658
|
}
|
|
11564
11659
|
|
|
11660
|
+
/** Represents an organization, e.g. a buyer or a seller */
|
|
11565
11661
|
export interface IOrganization {
|
|
11662
|
+
/** The name of the organization */
|
|
11566
11663
|
name?: string | undefined;
|
|
11664
|
+
/** The VAT ID for the organization */
|
|
11567
11665
|
vatId?: string | undefined;
|
|
11666
|
+
/** An email address for the organization */
|
|
11568
11667
|
email?: string | undefined;
|
|
11668
|
+
/** The name of a contact person */
|
|
11569
11669
|
contactPersonName?: string | undefined;
|
|
11670
|
+
/** The phone of a contact person */
|
|
11570
11671
|
contactPersonPhone?: string | undefined;
|
|
11672
|
+
/** The email of a contact person */
|
|
11571
11673
|
contactPersonEmail?: string | undefined;
|
|
11674
|
+
/** The address of the organization */
|
|
11572
11675
|
address?: string | undefined;
|
|
11676
|
+
/** The city of the organization */
|
|
11573
11677
|
city?: string | undefined;
|
|
11678
|
+
/** The zip code of the organization */
|
|
11574
11679
|
zipCode?: string | undefined;
|
|
11680
|
+
/** The ISO 3166-1 2 letter country code */
|
|
11575
11681
|
countryCode?: string | undefined;
|
|
11682
|
+
/** The state of the organization, e.g. a federal state in Germany */
|
|
11576
11683
|
state?: string | undefined;
|
|
11577
11684
|
}
|
|
11578
11685
|
|
|
11686
|
+
/** Represents a payee, meaning someone that receives the payment */
|
|
11579
11687
|
export class Payee implements IPayee {
|
|
11688
|
+
/** The name of the payee */
|
|
11580
11689
|
name?: string | undefined;
|
|
11690
|
+
/** The identifier of the payee */
|
|
11581
11691
|
identifier?: string | undefined;
|
|
11692
|
+
/** A registered identifier for the payee, e.g. a VAT ID
|
|
11693
|
+
or Tax ID */
|
|
11582
11694
|
legalRegistrationIdentifier?: string | undefined;
|
|
11583
11695
|
|
|
11584
11696
|
constructor(data?: IPayee) {
|
|
@@ -11614,14 +11726,22 @@ export class Payee implements IPayee {
|
|
|
11614
11726
|
}
|
|
11615
11727
|
}
|
|
11616
11728
|
|
|
11729
|
+
/** Represents a payee, meaning someone that receives the payment */
|
|
11617
11730
|
export interface IPayee {
|
|
11731
|
+
/** The name of the payee */
|
|
11618
11732
|
name?: string | undefined;
|
|
11733
|
+
/** The identifier of the payee */
|
|
11619
11734
|
identifier?: string | undefined;
|
|
11735
|
+
/** A registered identifier for the payee, e.g. a VAT ID
|
|
11736
|
+
or Tax ID */
|
|
11620
11737
|
legalRegistrationIdentifier?: string | undefined;
|
|
11621
11738
|
}
|
|
11622
11739
|
|
|
11740
|
+
/** Represents a note / text in an invoice */
|
|
11623
11741
|
export class InvoiceNote implements IInvoiceNote {
|
|
11742
|
+
/** Short summary / heading */
|
|
11624
11743
|
shortText?: string | undefined;
|
|
11744
|
+
/** Explanation of this note */
|
|
11625
11745
|
longText?: string | undefined;
|
|
11626
11746
|
|
|
11627
11747
|
constructor(data?: IInvoiceNote) {
|
|
@@ -11655,13 +11775,19 @@ export class InvoiceNote implements IInvoiceNote {
|
|
|
11655
11775
|
}
|
|
11656
11776
|
}
|
|
11657
11777
|
|
|
11778
|
+
/** Represents a note / text in an invoice */
|
|
11658
11779
|
export interface IInvoiceNote {
|
|
11780
|
+
/** Short summary / heading */
|
|
11659
11781
|
shortText?: string | undefined;
|
|
11782
|
+
/** Explanation of this note */
|
|
11660
11783
|
longText?: string | undefined;
|
|
11661
11784
|
}
|
|
11662
11785
|
|
|
11786
|
+
/** Represents an invoice period with start and end dates */
|
|
11663
11787
|
export class InvoicePeriod implements IInvoicePeriod {
|
|
11788
|
+
/** The start date */
|
|
11664
11789
|
start?: Date | undefined;
|
|
11790
|
+
/** The end date */
|
|
11665
11791
|
end?: Date | undefined;
|
|
11666
11792
|
|
|
11667
11793
|
constructor(data?: IInvoicePeriod) {
|
|
@@ -11695,19 +11821,35 @@ export class InvoicePeriod implements IInvoicePeriod {
|
|
|
11695
11821
|
}
|
|
11696
11822
|
}
|
|
11697
11823
|
|
|
11824
|
+
/** Represents an invoice period with start and end dates */
|
|
11698
11825
|
export interface IInvoicePeriod {
|
|
11826
|
+
/** The start date */
|
|
11699
11827
|
start?: Date | undefined;
|
|
11828
|
+
/** The end date */
|
|
11700
11829
|
end?: Date | undefined;
|
|
11701
11830
|
}
|
|
11702
11831
|
|
|
11832
|
+
/** Totals for the invoice */
|
|
11703
11833
|
export class InvoiceTotals implements IInvoiceTotals {
|
|
11834
|
+
/** Sum of all invoice items in net. */
|
|
11704
11835
|
totalNet?: number | undefined;
|
|
11836
|
+
/** This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice */
|
|
11705
11837
|
totalAllowances?: number | undefined;
|
|
11838
|
+
/** This is the sum of all charges in the invoice, except VAT. For example, late
|
|
11839
|
+
fees or surcharges. */
|
|
11706
11840
|
totalCharges?: number | undefined;
|
|
11841
|
+
/** This is the total net value of the invoice after applied allowances and charges,
|
|
11842
|
+
meaning the actual net sum to be paid. */
|
|
11707
11843
|
totalAfterDeductions?: number | undefined;
|
|
11844
|
+
/** The total amount of VAT in the invoice. */
|
|
11708
11845
|
totalVatAmount?: number | undefined;
|
|
11846
|
+
/** The total gross amount of the invoice, including all taxes and deductions. */
|
|
11709
11847
|
totalGross?: number | undefined;
|
|
11848
|
+
/** The total amount that has already been paid for this invoice, e.g. used when
|
|
11849
|
+
previous invoice sums are included here that have already been paid. */
|
|
11710
11850
|
alreadyPaidTotal?: number | undefined;
|
|
11851
|
+
/** The sum that needs to be paid for this invoice. This is the total gross amount
|
|
11852
|
+
minus the already paid amount. */
|
|
11711
11853
|
totalToBePaid?: number | undefined;
|
|
11712
11854
|
|
|
11713
11855
|
constructor(data?: IInvoiceTotals) {
|
|
@@ -11753,20 +11895,39 @@ export class InvoiceTotals implements IInvoiceTotals {
|
|
|
11753
11895
|
}
|
|
11754
11896
|
}
|
|
11755
11897
|
|
|
11898
|
+
/** Totals for the invoice */
|
|
11756
11899
|
export interface IInvoiceTotals {
|
|
11900
|
+
/** Sum of all invoice items in net. */
|
|
11757
11901
|
totalNet?: number | undefined;
|
|
11902
|
+
/** This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice */
|
|
11758
11903
|
totalAllowances?: number | undefined;
|
|
11904
|
+
/** This is the sum of all charges in the invoice, except VAT. For example, late
|
|
11905
|
+
fees or surcharges. */
|
|
11759
11906
|
totalCharges?: number | undefined;
|
|
11907
|
+
/** This is the total net value of the invoice after applied allowances and charges,
|
|
11908
|
+
meaning the actual net sum to be paid. */
|
|
11760
11909
|
totalAfterDeductions?: number | undefined;
|
|
11910
|
+
/** The total amount of VAT in the invoice. */
|
|
11761
11911
|
totalVatAmount?: number | undefined;
|
|
11912
|
+
/** The total gross amount of the invoice, including all taxes and deductions. */
|
|
11762
11913
|
totalGross?: number | undefined;
|
|
11914
|
+
/** The total amount that has already been paid for this invoice, e.g. used when
|
|
11915
|
+
previous invoice sums are included here that have already been paid. */
|
|
11763
11916
|
alreadyPaidTotal?: number | undefined;
|
|
11917
|
+
/** The sum that needs to be paid for this invoice. This is the total gross amount
|
|
11918
|
+
minus the already paid amount. */
|
|
11764
11919
|
totalToBePaid?: number | undefined;
|
|
11765
11920
|
}
|
|
11766
11921
|
|
|
11922
|
+
/** Instructions how payment for an invoice should be provided. */
|
|
11767
11923
|
export class PaymentInstructions implements IPaymentInstructions {
|
|
11924
|
+
/** Additional text to describe the payment instructions. */
|
|
11768
11925
|
description?: string | undefined;
|
|
11926
|
+
/** This should be a code according to UN/ECE 4461
|
|
11927
|
+
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
11928
|
+
and code "30" means non-SEPA Credit Transfer. */
|
|
11769
11929
|
paymentTypeCode?: string | undefined;
|
|
11930
|
+
/** A list of payment means that can be used to pay the invoice. */
|
|
11770
11931
|
paymentMeans?: PaymentMeans[] | undefined;
|
|
11771
11932
|
|
|
11772
11933
|
constructor(data?: IPaymentInstructions) {
|
|
@@ -11817,15 +11978,26 @@ export class PaymentInstructions implements IPaymentInstructions {
|
|
|
11817
11978
|
}
|
|
11818
11979
|
}
|
|
11819
11980
|
|
|
11981
|
+
/** Instructions how payment for an invoice should be provided. */
|
|
11820
11982
|
export interface IPaymentInstructions {
|
|
11983
|
+
/** Additional text to describe the payment instructions. */
|
|
11821
11984
|
description?: string | undefined;
|
|
11985
|
+
/** This should be a code according to UN/ECE 4461
|
|
11986
|
+
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
11987
|
+
and code "30" means non-SEPA Credit Transfer. */
|
|
11822
11988
|
paymentTypeCode?: string | undefined;
|
|
11989
|
+
/** A list of payment means that can be used to pay the invoice. */
|
|
11823
11990
|
paymentMeans?: IPaymentMeans[] | undefined;
|
|
11824
11991
|
}
|
|
11825
11992
|
|
|
11993
|
+
/** Represents a payment means for an invoice */
|
|
11826
11994
|
export class PaymentMeans implements IPaymentMeans {
|
|
11995
|
+
/** This is typically the IBAN or account number */
|
|
11827
11996
|
accountIdentifier?: string | undefined;
|
|
11997
|
+
/** The name for the account, typically the name of the owner for
|
|
11998
|
+
a bank account. */
|
|
11828
11999
|
accountName?: string | undefined;
|
|
12000
|
+
/** This can be the BIC */
|
|
11829
12001
|
serviceProviderIdentifier?: string | undefined;
|
|
11830
12002
|
|
|
11831
12003
|
constructor(data?: IPaymentMeans) {
|
|
@@ -11861,18 +12033,30 @@ export class PaymentMeans implements IPaymentMeans {
|
|
|
11861
12033
|
}
|
|
11862
12034
|
}
|
|
11863
12035
|
|
|
12036
|
+
/** Represents a payment means for an invoice */
|
|
11864
12037
|
export interface IPaymentMeans {
|
|
12038
|
+
/** This is typically the IBAN or account number */
|
|
11865
12039
|
accountIdentifier?: string | undefined;
|
|
12040
|
+
/** The name for the account, typically the name of the owner for
|
|
12041
|
+
a bank account. */
|
|
11866
12042
|
accountName?: string | undefined;
|
|
12043
|
+
/** This can be the BIC */
|
|
11867
12044
|
serviceProviderIdentifier?: string | undefined;
|
|
11868
12045
|
}
|
|
11869
12046
|
|
|
12047
|
+
/** Represents a document / attachment that is included with the invoice */
|
|
11870
12048
|
export class SupportingDocument implements ISupportingDocument {
|
|
12049
|
+
/** This is typically an id or a name */
|
|
11871
12050
|
documentReference?: string | undefined;
|
|
12051
|
+
/** A description of the document */
|
|
11872
12052
|
description?: string | undefined;
|
|
12053
|
+
/** A link to the document in case this is an external reference */
|
|
11873
12054
|
externalDocumentUrl?: string | undefined;
|
|
12055
|
+
/** The document in base64 encoded form as binary data */
|
|
11874
12056
|
documentBase64?: string | undefined;
|
|
12057
|
+
/** This should be present if DocumentBase64 is set. */
|
|
11875
12058
|
fileName?: string | undefined;
|
|
12059
|
+
/** The type of the document */
|
|
11876
12060
|
documentMimeType!: AttachmentMimeType;
|
|
11877
12061
|
|
|
11878
12062
|
constructor(data?: ISupportingDocument) {
|
|
@@ -11914,15 +12098,23 @@ export class SupportingDocument implements ISupportingDocument {
|
|
|
11914
12098
|
}
|
|
11915
12099
|
}
|
|
11916
12100
|
|
|
12101
|
+
/** Represents a document / attachment that is included with the invoice */
|
|
11917
12102
|
export interface ISupportingDocument {
|
|
12103
|
+
/** This is typically an id or a name */
|
|
11918
12104
|
documentReference?: string | undefined;
|
|
12105
|
+
/** A description of the document */
|
|
11919
12106
|
description?: string | undefined;
|
|
12107
|
+
/** A link to the document in case this is an external reference */
|
|
11920
12108
|
externalDocumentUrl?: string | undefined;
|
|
12109
|
+
/** The document in base64 encoded form as binary data */
|
|
11921
12110
|
documentBase64?: string | undefined;
|
|
12111
|
+
/** This should be present if DocumentBase64 is set. */
|
|
11922
12112
|
fileName?: string | undefined;
|
|
12113
|
+
/** The type of the document */
|
|
11923
12114
|
documentMimeType: AttachmentMimeType;
|
|
11924
12115
|
}
|
|
11925
12116
|
|
|
12117
|
+
/** Describes a mimne type of a document */
|
|
11926
12118
|
export enum AttachmentMimeType {
|
|
11927
12119
|
Unknown = "Unknown",
|
|
11928
12120
|
Pdf = "Pdf",
|
|
@@ -11933,12 +12125,22 @@ export enum AttachmentMimeType {
|
|
|
11933
12125
|
OpenOfficeSpreadsheet = "OpenOfficeSpreadsheet",
|
|
11934
12126
|
}
|
|
11935
12127
|
|
|
12128
|
+
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
11936
12129
|
export class VatBreakdown implements IVatBreakdown {
|
|
12130
|
+
/** The total net amount of this VAT category */
|
|
11937
12131
|
netTaxableAmount?: number | undefined;
|
|
12132
|
+
/** The total VAT */
|
|
11938
12133
|
vatAmount?: number | undefined;
|
|
12134
|
+
/** The category of the VAT */
|
|
11939
12135
|
vatCategory!: VatCategory;
|
|
12136
|
+
/** The actual tax rate as a decimal value,
|
|
12137
|
+
e.g. 19% would be 0.19 */
|
|
11940
12138
|
taxRate?: number | undefined;
|
|
12139
|
+
/** If the VAT is exempt, there should be a description here.
|
|
12140
|
+
For example, in reverse charge scenarios, this text
|
|
12141
|
+
should contain a reference to "Reverse charge according to ...". */
|
|
11941
12142
|
vatExemptionReasonText?: string | undefined;
|
|
12143
|
+
/** A code from the VAT exemption reason code list(VATEX)“ */
|
|
11942
12144
|
vatExemptionReasonCode?: string | undefined;
|
|
11943
12145
|
|
|
11944
12146
|
constructor(data?: IVatBreakdown) {
|
|
@@ -11980,15 +12182,26 @@ export class VatBreakdown implements IVatBreakdown {
|
|
|
11980
12182
|
}
|
|
11981
12183
|
}
|
|
11982
12184
|
|
|
12185
|
+
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
11983
12186
|
export interface IVatBreakdown {
|
|
12187
|
+
/** The total net amount of this VAT category */
|
|
11984
12188
|
netTaxableAmount?: number | undefined;
|
|
12189
|
+
/** The total VAT */
|
|
11985
12190
|
vatAmount?: number | undefined;
|
|
12191
|
+
/** The category of the VAT */
|
|
11986
12192
|
vatCategory: VatCategory;
|
|
12193
|
+
/** The actual tax rate as a decimal value,
|
|
12194
|
+
e.g. 19% would be 0.19 */
|
|
11987
12195
|
taxRate?: number | undefined;
|
|
12196
|
+
/** If the VAT is exempt, there should be a description here.
|
|
12197
|
+
For example, in reverse charge scenarios, this text
|
|
12198
|
+
should contain a reference to "Reverse charge according to ...". */
|
|
11988
12199
|
vatExemptionReasonText?: string | undefined;
|
|
12200
|
+
/** A code from the VAT exemption reason code list(VATEX)“ */
|
|
11989
12201
|
vatExemptionReasonCode?: string | undefined;
|
|
11990
12202
|
}
|
|
11991
12203
|
|
|
12204
|
+
/** The category used in a VatBreakdown"/> */
|
|
11992
12205
|
export enum VatCategory {
|
|
11993
12206
|
Unknown = "Unknown",
|
|
11994
12207
|
StandardRate = "StandardRate",
|
|
@@ -12002,13 +12215,24 @@ export enum VatCategory {
|
|
|
12002
12215
|
TaxInCeutaAndMelilla = "TaxInCeutaAndMelilla",
|
|
12003
12216
|
}
|
|
12004
12217
|
|
|
12218
|
+
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
12005
12219
|
export class InvoiceAllowance implements IInvoiceAllowance {
|
|
12220
|
+
/** The net amount of the allowance */
|
|
12006
12221
|
netAmount?: number | undefined;
|
|
12222
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12223
|
+
and give the base amount that is being used for the calculation */
|
|
12007
12224
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
12225
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12226
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12008
12227
|
relativeAllowancePercentage?: number | undefined;
|
|
12228
|
+
/** The VAT category for the allowance */
|
|
12009
12229
|
vatCategory!: VatCategory;
|
|
12230
|
+
/** The actual tax rate as a decimal value,
|
|
12231
|
+
meaning 19% would be 0.19 */
|
|
12010
12232
|
vatRate?: number | undefined;
|
|
12233
|
+
/** A description of the allowance. */
|
|
12011
12234
|
reason?: string | undefined;
|
|
12235
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
12012
12236
|
reasonCode?: string | undefined;
|
|
12013
12237
|
|
|
12014
12238
|
constructor(data?: IInvoiceAllowance) {
|
|
@@ -12052,23 +12276,45 @@ export class InvoiceAllowance implements IInvoiceAllowance {
|
|
|
12052
12276
|
}
|
|
12053
12277
|
}
|
|
12054
12278
|
|
|
12279
|
+
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
12055
12280
|
export interface IInvoiceAllowance {
|
|
12281
|
+
/** The net amount of the allowance */
|
|
12056
12282
|
netAmount?: number | undefined;
|
|
12283
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12284
|
+
and give the base amount that is being used for the calculation */
|
|
12057
12285
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
12286
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12287
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12058
12288
|
relativeAllowancePercentage?: number | undefined;
|
|
12289
|
+
/** The VAT category for the allowance */
|
|
12059
12290
|
vatCategory: VatCategory;
|
|
12291
|
+
/** The actual tax rate as a decimal value,
|
|
12292
|
+
meaning 19% would be 0.19 */
|
|
12060
12293
|
vatRate?: number | undefined;
|
|
12294
|
+
/** A description of the allowance. */
|
|
12061
12295
|
reason?: string | undefined;
|
|
12296
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
12062
12297
|
reasonCode?: string | undefined;
|
|
12063
12298
|
}
|
|
12064
12299
|
|
|
12300
|
+
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
12065
12301
|
export class InvoiceCharge implements IInvoiceCharge {
|
|
12302
|
+
/** The net amount of the charge */
|
|
12066
12303
|
netAmount?: number | undefined;
|
|
12304
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12305
|
+
and give the base amount that is being used for the calculation */
|
|
12067
12306
|
relativeChargeBaseAmount?: number | undefined;
|
|
12307
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12308
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12068
12309
|
relativeChargePercentage?: number | undefined;
|
|
12310
|
+
/** The VAT category for the charge */
|
|
12069
12311
|
vatCategory!: VatCategory;
|
|
12312
|
+
/** The actual tax rate as a decimal value,
|
|
12313
|
+
meaning 19% would be 0.19 */
|
|
12070
12314
|
vatRate?: number | undefined;
|
|
12315
|
+
/** A description of the charge. */
|
|
12071
12316
|
reason?: string | undefined;
|
|
12317
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
12072
12318
|
reasonCode?: string | undefined;
|
|
12073
12319
|
|
|
12074
12320
|
constructor(data?: IInvoiceCharge) {
|
|
@@ -12112,30 +12358,61 @@ export class InvoiceCharge implements IInvoiceCharge {
|
|
|
12112
12358
|
}
|
|
12113
12359
|
}
|
|
12114
12360
|
|
|
12361
|
+
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
12115
12362
|
export interface IInvoiceCharge {
|
|
12363
|
+
/** The net amount of the charge */
|
|
12116
12364
|
netAmount?: number | undefined;
|
|
12365
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12366
|
+
and give the base amount that is being used for the calculation */
|
|
12117
12367
|
relativeChargeBaseAmount?: number | undefined;
|
|
12368
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12369
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12118
12370
|
relativeChargePercentage?: number | undefined;
|
|
12371
|
+
/** The VAT category for the charge */
|
|
12119
12372
|
vatCategory: VatCategory;
|
|
12373
|
+
/** The actual tax rate as a decimal value,
|
|
12374
|
+
meaning 19% would be 0.19 */
|
|
12120
12375
|
vatRate?: number | undefined;
|
|
12376
|
+
/** A description of the charge. */
|
|
12121
12377
|
reason?: string | undefined;
|
|
12378
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
12122
12379
|
reasonCode?: string | undefined;
|
|
12123
12380
|
}
|
|
12124
12381
|
|
|
12382
|
+
/** Represents a single invoice line item */
|
|
12125
12383
|
export class InvoiceLineItem implements IInvoiceLineItem {
|
|
12384
|
+
/** An unique identifier for the line item */
|
|
12126
12385
|
identifier?: string | undefined;
|
|
12386
|
+
/** An unstructured note to classify line items */
|
|
12127
12387
|
note?: string | undefined;
|
|
12388
|
+
/** A seller-defined object identifier for this line item,
|
|
12389
|
+
meaning an identifier for the actual line. This could be
|
|
12390
|
+
a numbering sequence or a reference to a product. */
|
|
12128
12391
|
objectIdentifier?: string | undefined;
|
|
12392
|
+
/** The actual invoiced quantity of the line item */
|
|
12129
12393
|
quantity?: number | undefined;
|
|
12394
|
+
/** A code for the unit of the quantity. This should be a code as defined
|
|
12395
|
+
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
12396
|
+
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
12397
|
+
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names) */
|
|
12130
12398
|
unitCode?: string | undefined;
|
|
12399
|
+
/** The net amount for this line item */
|
|
12131
12400
|
netAmount?: number | undefined;
|
|
12401
|
+
/** A reference to an item in the buyers purachase order */
|
|
12132
12402
|
purchaseOrderReference?: string | undefined;
|
|
12403
|
+
/** Information about the invoice period for this line item. */
|
|
12133
12404
|
lineItemPeriod?: InvoicePeriod | undefined;
|
|
12405
|
+
/** Allowances specific to this line item */
|
|
12134
12406
|
allowances?: LineItemAllowance[] | undefined;
|
|
12407
|
+
/** charges specific to this line item */
|
|
12135
12408
|
charges?: LineItemCharge[] | undefined;
|
|
12409
|
+
/** Price details for this line item. */
|
|
12136
12410
|
priceDetails?: LineItemPriceDetail | undefined;
|
|
12411
|
+
/** VAT information for this line item */
|
|
12137
12412
|
vatInformation?: LineItemVatInformation[] | undefined;
|
|
12413
|
+
/** Information about this line item */
|
|
12138
12414
|
itemInformation?: LineItemInformation | undefined;
|
|
12415
|
+
/** Line items can be nested, in which case this property holds the sub items */
|
|
12139
12416
|
subItems?: InvoiceLineItem[] | undefined;
|
|
12140
12417
|
|
|
12141
12418
|
constructor(data?: IInvoiceLineItem) {
|
|
@@ -12256,28 +12533,56 @@ export class InvoiceLineItem implements IInvoiceLineItem {
|
|
|
12256
12533
|
}
|
|
12257
12534
|
}
|
|
12258
12535
|
|
|
12536
|
+
/** Represents a single invoice line item */
|
|
12259
12537
|
export interface IInvoiceLineItem {
|
|
12538
|
+
/** An unique identifier for the line item */
|
|
12260
12539
|
identifier?: string | undefined;
|
|
12540
|
+
/** An unstructured note to classify line items */
|
|
12261
12541
|
note?: string | undefined;
|
|
12542
|
+
/** A seller-defined object identifier for this line item,
|
|
12543
|
+
meaning an identifier for the actual line. This could be
|
|
12544
|
+
a numbering sequence or a reference to a product. */
|
|
12262
12545
|
objectIdentifier?: string | undefined;
|
|
12546
|
+
/** The actual invoiced quantity of the line item */
|
|
12263
12547
|
quantity?: number | undefined;
|
|
12548
|
+
/** A code for the unit of the quantity. This should be a code as defined
|
|
12549
|
+
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
12550
|
+
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
12551
|
+
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names) */
|
|
12264
12552
|
unitCode?: string | undefined;
|
|
12553
|
+
/** The net amount for this line item */
|
|
12265
12554
|
netAmount?: number | undefined;
|
|
12555
|
+
/** A reference to an item in the buyers purachase order */
|
|
12266
12556
|
purchaseOrderReference?: string | undefined;
|
|
12557
|
+
/** Information about the invoice period for this line item. */
|
|
12267
12558
|
lineItemPeriod?: IInvoicePeriod | undefined;
|
|
12559
|
+
/** Allowances specific to this line item */
|
|
12268
12560
|
allowances?: ILineItemAllowance[] | undefined;
|
|
12561
|
+
/** charges specific to this line item */
|
|
12269
12562
|
charges?: ILineItemCharge[] | undefined;
|
|
12563
|
+
/** Price details for this line item. */
|
|
12270
12564
|
priceDetails?: ILineItemPriceDetail | undefined;
|
|
12565
|
+
/** VAT information for this line item */
|
|
12271
12566
|
vatInformation?: ILineItemVatInformation[] | undefined;
|
|
12567
|
+
/** Information about this line item */
|
|
12272
12568
|
itemInformation?: ILineItemInformation | undefined;
|
|
12569
|
+
/** Line items can be nested, in which case this property holds the sub items */
|
|
12273
12570
|
subItems?: IInvoiceLineItem[] | undefined;
|
|
12274
12571
|
}
|
|
12275
12572
|
|
|
12573
|
+
/** Allowance for a single line item */
|
|
12276
12574
|
export class LineItemAllowance implements ILineItemAllowance {
|
|
12575
|
+
/** The net amount of the allowance */
|
|
12277
12576
|
netAmount?: number | undefined;
|
|
12577
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12578
|
+
and give the base amount that is being used for the calculation */
|
|
12278
12579
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
12580
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12581
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12279
12582
|
relativeAllowancePercentage?: number | undefined;
|
|
12583
|
+
/** A description of the allowance. */
|
|
12280
12584
|
reason?: string | undefined;
|
|
12585
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
12281
12586
|
reasonCode?: string | undefined;
|
|
12282
12587
|
|
|
12283
12588
|
constructor(data?: ILineItemAllowance) {
|
|
@@ -12317,19 +12622,35 @@ export class LineItemAllowance implements ILineItemAllowance {
|
|
|
12317
12622
|
}
|
|
12318
12623
|
}
|
|
12319
12624
|
|
|
12625
|
+
/** Allowance for a single line item */
|
|
12320
12626
|
export interface ILineItemAllowance {
|
|
12627
|
+
/** The net amount of the allowance */
|
|
12321
12628
|
netAmount?: number | undefined;
|
|
12629
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12630
|
+
and give the base amount that is being used for the calculation */
|
|
12322
12631
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
12632
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
12633
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12323
12634
|
relativeAllowancePercentage?: number | undefined;
|
|
12635
|
+
/** A description of the allowance. */
|
|
12324
12636
|
reason?: string | undefined;
|
|
12637
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
12325
12638
|
reasonCode?: string | undefined;
|
|
12326
12639
|
}
|
|
12327
12640
|
|
|
12641
|
+
/** Charge for a single line item */
|
|
12328
12642
|
export class LineItemCharge implements ILineItemCharge {
|
|
12643
|
+
/** The net amount of the charge */
|
|
12329
12644
|
netAmount?: number | undefined;
|
|
12645
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12646
|
+
and give the base amount that is being used for the calculation */
|
|
12330
12647
|
relativeChargeBaseAmount?: number | undefined;
|
|
12648
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12649
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12331
12650
|
relativeChargePercentage?: number | undefined;
|
|
12651
|
+
/** A description of the charge. */
|
|
12332
12652
|
reason?: string | undefined;
|
|
12653
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
12333
12654
|
reasonCode?: string | undefined;
|
|
12334
12655
|
|
|
12335
12656
|
constructor(data?: ILineItemCharge) {
|
|
@@ -12369,19 +12690,35 @@ export class LineItemCharge implements ILineItemCharge {
|
|
|
12369
12690
|
}
|
|
12370
12691
|
}
|
|
12371
12692
|
|
|
12693
|
+
/** Charge for a single line item */
|
|
12372
12694
|
export interface ILineItemCharge {
|
|
12695
|
+
/** The net amount of the charge */
|
|
12373
12696
|
netAmount?: number | undefined;
|
|
12697
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12698
|
+
and give the base amount that is being used for the calculation */
|
|
12374
12699
|
relativeChargeBaseAmount?: number | undefined;
|
|
12700
|
+
/** If this is a relative / percentage charge, this should be set
|
|
12701
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
12375
12702
|
relativeChargePercentage?: number | undefined;
|
|
12703
|
+
/** A description of the charge. */
|
|
12376
12704
|
reason?: string | undefined;
|
|
12705
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
12377
12706
|
reasonCode?: string | undefined;
|
|
12378
12707
|
}
|
|
12379
12708
|
|
|
12709
|
+
/** Price details about a line item */
|
|
12380
12710
|
export class LineItemPriceDetail implements ILineItemPriceDetail {
|
|
12711
|
+
/** The net price of this line item */
|
|
12381
12712
|
netPrice?: number | undefined;
|
|
12382
|
-
discount
|
|
12713
|
+
/** A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
12714
|
+
and the actual invoiced price GrossPrice. */
|
|
12715
|
+
absoluteDiscountPerItem?: number | undefined;
|
|
12716
|
+
/** The gross price of this line item, meaning the price without taxes
|
|
12717
|
+
that will be invoiced */
|
|
12383
12718
|
grossPrice?: number | undefined;
|
|
12719
|
+
/** The quantity for which this price is valid */
|
|
12384
12720
|
baseQuantity?: number | undefined;
|
|
12721
|
+
/** A code representing the unit for the base quantity */
|
|
12385
12722
|
baseQuantityUnitCode?: string | undefined;
|
|
12386
12723
|
|
|
12387
12724
|
constructor(data?: ILineItemPriceDetail) {
|
|
@@ -12396,7 +12733,7 @@ export class LineItemPriceDetail implements ILineItemPriceDetail {
|
|
|
12396
12733
|
init(_data?: any) {
|
|
12397
12734
|
if (_data) {
|
|
12398
12735
|
this.netPrice = _data["netPrice"];
|
|
12399
|
-
this.
|
|
12736
|
+
this.absoluteDiscountPerItem = _data["absoluteDiscountPerItem"];
|
|
12400
12737
|
this.grossPrice = _data["grossPrice"];
|
|
12401
12738
|
this.baseQuantity = _data["baseQuantity"];
|
|
12402
12739
|
this.baseQuantityUnitCode = _data["baseQuantityUnitCode"];
|
|
@@ -12413,7 +12750,7 @@ export class LineItemPriceDetail implements ILineItemPriceDetail {
|
|
|
12413
12750
|
toJSON(data?: any) {
|
|
12414
12751
|
data = typeof data === 'object' ? data : {};
|
|
12415
12752
|
data["netPrice"] = this.netPrice;
|
|
12416
|
-
data["
|
|
12753
|
+
data["absoluteDiscountPerItem"] = this.absoluteDiscountPerItem;
|
|
12417
12754
|
data["grossPrice"] = this.grossPrice;
|
|
12418
12755
|
data["baseQuantity"] = this.baseQuantity;
|
|
12419
12756
|
data["baseQuantityUnitCode"] = this.baseQuantityUnitCode;
|
|
@@ -12421,16 +12758,28 @@ export class LineItemPriceDetail implements ILineItemPriceDetail {
|
|
|
12421
12758
|
}
|
|
12422
12759
|
}
|
|
12423
12760
|
|
|
12761
|
+
/** Price details about a line item */
|
|
12424
12762
|
export interface ILineItemPriceDetail {
|
|
12763
|
+
/** The net price of this line item */
|
|
12425
12764
|
netPrice?: number | undefined;
|
|
12426
|
-
discount
|
|
12765
|
+
/** A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
12766
|
+
and the actual invoiced price GrossPrice. */
|
|
12767
|
+
absoluteDiscountPerItem?: number | undefined;
|
|
12768
|
+
/** The gross price of this line item, meaning the price without taxes
|
|
12769
|
+
that will be invoiced */
|
|
12427
12770
|
grossPrice?: number | undefined;
|
|
12771
|
+
/** The quantity for which this price is valid */
|
|
12428
12772
|
baseQuantity?: number | undefined;
|
|
12773
|
+
/** A code representing the unit for the base quantity */
|
|
12429
12774
|
baseQuantityUnitCode?: string | undefined;
|
|
12430
12775
|
}
|
|
12431
12776
|
|
|
12777
|
+
/** VAT information for a single line item */
|
|
12432
12778
|
export class LineItemVatInformation implements ILineItemVatInformation {
|
|
12779
|
+
/** The VAT category for the charge */
|
|
12433
12780
|
vatCategory!: VatCategory;
|
|
12781
|
+
/** The actual tax rate as a decimal value,
|
|
12782
|
+
meaning 19% would be 0.19 */
|
|
12434
12783
|
vatRate?: number | undefined;
|
|
12435
12784
|
|
|
12436
12785
|
constructor(data?: ILineItemVatInformation) {
|
|
@@ -12464,19 +12813,32 @@ export class LineItemVatInformation implements ILineItemVatInformation {
|
|
|
12464
12813
|
}
|
|
12465
12814
|
}
|
|
12466
12815
|
|
|
12816
|
+
/** VAT information for a single line item */
|
|
12467
12817
|
export interface ILineItemVatInformation {
|
|
12818
|
+
/** The VAT category for the charge */
|
|
12468
12819
|
vatCategory: VatCategory;
|
|
12820
|
+
/** The actual tax rate as a decimal value,
|
|
12821
|
+
meaning 19% would be 0.19 */
|
|
12469
12822
|
vatRate?: number | undefined;
|
|
12470
12823
|
}
|
|
12471
12824
|
|
|
12825
|
+
/** Information about a single line item */
|
|
12472
12826
|
export class LineItemInformation implements ILineItemInformation {
|
|
12827
|
+
/** A name for the line item */
|
|
12473
12828
|
name?: string | undefined;
|
|
12829
|
+
/** A description for the line item */
|
|
12474
12830
|
description?: string | undefined;
|
|
12831
|
+
/** An identifier assigned by the seller, e.g. an internal article number */
|
|
12475
12832
|
sellerIdentifier?: string | undefined;
|
|
12833
|
+
/** An identifier assigned by the buyer, e.g. an internal article number */
|
|
12476
12834
|
buyerIdentifier?: string | undefined;
|
|
12835
|
+
/** A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
12477
12836
|
standardIdentifier?: string | undefined;
|
|
12837
|
+
/** A list of classification identifiers for the line item */
|
|
12478
12838
|
classificationIdentifiers?: string[] | undefined;
|
|
12839
|
+
/** The origin country code according to ISO 3166-1 in 2 letter format */
|
|
12479
12840
|
countryOfOrigin?: string | undefined;
|
|
12841
|
+
/** Optional additional attributes for this line item */
|
|
12480
12842
|
attributes?: LineItemAttribute[] | undefined;
|
|
12481
12843
|
|
|
12482
12844
|
constructor(data?: ILineItemInformation) {
|
|
@@ -12545,19 +12907,31 @@ export class LineItemInformation implements ILineItemInformation {
|
|
|
12545
12907
|
}
|
|
12546
12908
|
}
|
|
12547
12909
|
|
|
12910
|
+
/** Information about a single line item */
|
|
12548
12911
|
export interface ILineItemInformation {
|
|
12912
|
+
/** A name for the line item */
|
|
12549
12913
|
name?: string | undefined;
|
|
12914
|
+
/** A description for the line item */
|
|
12550
12915
|
description?: string | undefined;
|
|
12916
|
+
/** An identifier assigned by the seller, e.g. an internal article number */
|
|
12551
12917
|
sellerIdentifier?: string | undefined;
|
|
12918
|
+
/** An identifier assigned by the buyer, e.g. an internal article number */
|
|
12552
12919
|
buyerIdentifier?: string | undefined;
|
|
12920
|
+
/** A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
12553
12921
|
standardIdentifier?: string | undefined;
|
|
12922
|
+
/** A list of classification identifiers for the line item */
|
|
12554
12923
|
classificationIdentifiers?: string[] | undefined;
|
|
12924
|
+
/** The origin country code according to ISO 3166-1 in 2 letter format */
|
|
12555
12925
|
countryOfOrigin?: string | undefined;
|
|
12926
|
+
/** Optional additional attributes for this line item */
|
|
12556
12927
|
attributes?: ILineItemAttribute[] | undefined;
|
|
12557
12928
|
}
|
|
12558
12929
|
|
|
12930
|
+
/** A key-value pair for additional information */
|
|
12559
12931
|
export class LineItemAttribute implements ILineItemAttribute {
|
|
12932
|
+
/** The key / name of the attribute */
|
|
12560
12933
|
name!: string;
|
|
12934
|
+
/** The value of the attribute */
|
|
12561
12935
|
value?: string | undefined;
|
|
12562
12936
|
|
|
12563
12937
|
constructor(data?: ILineItemAttribute) {
|
|
@@ -12591,28 +12965,46 @@ export class LineItemAttribute implements ILineItemAttribute {
|
|
|
12591
12965
|
}
|
|
12592
12966
|
}
|
|
12593
12967
|
|
|
12968
|
+
/** A key-value pair for additional information */
|
|
12594
12969
|
export interface ILineItemAttribute {
|
|
12970
|
+
/** The key / name of the attribute */
|
|
12595
12971
|
name: string;
|
|
12972
|
+
/** The value of the attribute */
|
|
12596
12973
|
value?: string | undefined;
|
|
12597
12974
|
}
|
|
12598
12975
|
|
|
12976
|
+
/** This enum represents the source of an invoice, e.g. from which format it was imported */
|
|
12599
12977
|
export enum SourceType {
|
|
12600
12978
|
Self = "Self",
|
|
12601
12979
|
Ubl = "Ubl",
|
|
12602
12980
|
Cii = "Cii",
|
|
12603
12981
|
}
|
|
12604
12982
|
|
|
12983
|
+
/** This is a wrapper class that maps Dangl.AVA projects along with additional required information to create invoices */
|
|
12605
12984
|
export class AvaProjectWrapper implements IAvaProjectWrapper {
|
|
12985
|
+
/** The Dangl.AVA.Project from which to convert */
|
|
12606
12986
|
project!: ProjectDto;
|
|
12987
|
+
/** The number of the invoice */
|
|
12607
12988
|
invoiceNumber?: string | undefined;
|
|
12989
|
+
/** Attached documents to the invoice */
|
|
12608
12990
|
documents?: SupportingDocument[] | undefined;
|
|
12991
|
+
/** The period during which the services or goods were delivered */
|
|
12609
12992
|
invoicePeriod?: InvoicePeriod | undefined;
|
|
12993
|
+
/** Instructions how to perform the payment */
|
|
12610
12994
|
paymentInstructions?: PaymentInstructions | undefined;
|
|
12995
|
+
/** The type of the invoice */
|
|
12611
12996
|
invoiceType!: InvoiceType;
|
|
12997
|
+
/** Until when the payment is due */
|
|
12612
12998
|
paymentDueDate?: Date | undefined;
|
|
12999
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
12613
13000
|
paymentTerms?: string | undefined;
|
|
13001
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
12614
13002
|
previousInvoices?: PreviousInvoice[] | undefined;
|
|
13003
|
+
/** If parts of this invoice (or of previous invoices) have already been paid,
|
|
13004
|
+
then this property can be used to specify that some parts of the invoice
|
|
13005
|
+
are already paid and this will be deducted from the to be paid amount. */
|
|
12615
13006
|
alreadyPaidTotalGross!: number;
|
|
13007
|
+
/** An object holding reference used in this invoice */
|
|
12616
13008
|
references?: References | undefined;
|
|
12617
13009
|
|
|
12618
13010
|
constructor(data?: IAvaProjectWrapper) {
|
|
@@ -12701,17 +13093,31 @@ export class AvaProjectWrapper implements IAvaProjectWrapper {
|
|
|
12701
13093
|
}
|
|
12702
13094
|
}
|
|
12703
13095
|
|
|
13096
|
+
/** This is a wrapper class that maps Dangl.AVA projects along with additional required information to create invoices */
|
|
12704
13097
|
export interface IAvaProjectWrapper {
|
|
13098
|
+
/** The Dangl.AVA.Project from which to convert */
|
|
12705
13099
|
project: IProjectDto;
|
|
13100
|
+
/** The number of the invoice */
|
|
12706
13101
|
invoiceNumber?: string | undefined;
|
|
13102
|
+
/** Attached documents to the invoice */
|
|
12707
13103
|
documents?: ISupportingDocument[] | undefined;
|
|
13104
|
+
/** The period during which the services or goods were delivered */
|
|
12708
13105
|
invoicePeriod?: IInvoicePeriod | undefined;
|
|
13106
|
+
/** Instructions how to perform the payment */
|
|
12709
13107
|
paymentInstructions?: IPaymentInstructions | undefined;
|
|
13108
|
+
/** The type of the invoice */
|
|
12710
13109
|
invoiceType: InvoiceType;
|
|
13110
|
+
/** Until when the payment is due */
|
|
12711
13111
|
paymentDueDate?: Date | undefined;
|
|
13112
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
12712
13113
|
paymentTerms?: string | undefined;
|
|
13114
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
12713
13115
|
previousInvoices?: IPreviousInvoice[] | undefined;
|
|
13116
|
+
/** If parts of this invoice (or of previous invoices) have already been paid,
|
|
13117
|
+
then this property can be used to specify that some parts of the invoice
|
|
13118
|
+
are already paid and this will be deducted from the to be paid amount. */
|
|
12714
13119
|
alreadyPaidTotalGross: number;
|
|
13120
|
+
/** An object holding reference used in this invoice */
|
|
12715
13121
|
references?: IReferences | undefined;
|
|
12716
13122
|
}
|
|
12717
13123
|
|