@dangl/avacloud-client-node 1.30.0 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/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.d.ts
CHANGED
|
@@ -1883,6 +1883,8 @@ export declare class ItemNumberSchemaDto implements IItemNumberSchemaDto {
|
|
|
1883
1883
|
readonly schemaIsCorrectlyDefined: boolean;
|
|
1884
1884
|
/** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
|
|
1885
1885
|
allowUpperCaseLettering: boolean;
|
|
1886
|
+
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
1887
|
+
disableLeftPaddingTiersWithFiller: boolean;
|
|
1886
1888
|
constructor(data?: IItemNumberSchemaDto);
|
|
1887
1889
|
init(_data?: any): void;
|
|
1888
1890
|
static fromJS(data: any): ItemNumberSchemaDto;
|
|
@@ -1908,6 +1910,8 @@ export interface IItemNumberSchemaDto {
|
|
|
1908
1910
|
schemaIsCorrectlyDefined: boolean;
|
|
1909
1911
|
/** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
|
|
1910
1912
|
allowUpperCaseLettering: boolean;
|
|
1913
|
+
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
1914
|
+
disableLeftPaddingTiersWithFiller: boolean;
|
|
1911
1915
|
}
|
|
1912
1916
|
/** Represents information about a single Tier in an ItemNumber. */
|
|
1913
1917
|
export declare class ItemNumberSchemaTierDto implements IItemNumberSchemaTierDto {
|
|
@@ -4089,56 +4093,105 @@ and not lead to any schema being generated. It is recommended to enable this opt
|
|
|
4089
4093
|
reasons. */
|
|
4090
4094
|
treatNullItemNumberSchemaAsInvalid: boolean;
|
|
4091
4095
|
}
|
|
4096
|
+
/** This class represents an invoice */
|
|
4092
4097
|
export declare class Invoice implements IInvoice {
|
|
4098
|
+
/** The number of the invoice */
|
|
4093
4099
|
invoiceNumber?: string | undefined;
|
|
4100
|
+
/** The date of the invoice */
|
|
4094
4101
|
invoiceDate?: Date | undefined;
|
|
4102
|
+
/** The type of the invoice */
|
|
4095
4103
|
invoiceType?: InvoiceType | undefined;
|
|
4104
|
+
/** The three letter ISO currency code */
|
|
4096
4105
|
currencyCode?: string | undefined;
|
|
4106
|
+
/** Until when the payment is due */
|
|
4097
4107
|
paymentDueDate?: Date | undefined;
|
|
4108
|
+
/** An object holding reference used in this invoice */
|
|
4098
4109
|
references?: References | undefined;
|
|
4110
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4099
4111
|
paymentTerms?: string | undefined;
|
|
4112
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
4100
4113
|
previousInvoices?: PreviousInvoice[] | undefined;
|
|
4114
|
+
/** Information about the buyer */
|
|
4101
4115
|
buyer?: Organization | undefined;
|
|
4116
|
+
/** Information about the seller */
|
|
4102
4117
|
seller?: Organization | undefined;
|
|
4118
|
+
/** A payee is someone who receives the payment that is different from the seller */
|
|
4103
4119
|
payee?: Payee | undefined;
|
|
4120
|
+
/** If present, this is an unstructured text that can be used to give additional information
|
|
4121
|
+
about the invoice. */
|
|
4104
4122
|
invoiceNotes?: InvoiceNote[] | undefined;
|
|
4123
|
+
/** The period during which the services or goods were delivered */
|
|
4105
4124
|
invoicePeriod?: InvoicePeriod | undefined;
|
|
4125
|
+
/** Totals for the invoice */
|
|
4106
4126
|
totals?: InvoiceTotals | undefined;
|
|
4127
|
+
/** Instructions how to perform the payment */
|
|
4107
4128
|
paymentInstructions?: PaymentInstructions | undefined;
|
|
4129
|
+
/** Attached documents to the invoice */
|
|
4108
4130
|
documents?: SupportingDocument[] | undefined;
|
|
4131
|
+
/** This is used to list VAT by category, e.g. for invoices
|
|
4132
|
+
where parts are in different VAT categories */
|
|
4109
4133
|
vatBreakdown?: VatBreakdown[] | undefined;
|
|
4134
|
+
/** Allowances / deductions on the invoice */
|
|
4110
4135
|
allowances?: InvoiceAllowance[] | undefined;
|
|
4136
|
+
/** Charges / additional costs on the invoice */
|
|
4111
4137
|
charges?: InvoiceCharge[] | undefined;
|
|
4138
|
+
/** Single line items in the invoice */
|
|
4112
4139
|
lineItems?: InvoiceLineItem[] | undefined;
|
|
4140
|
+
/** The source type from which the invoice was created */
|
|
4113
4141
|
sourceType: SourceType;
|
|
4114
4142
|
constructor(data?: IInvoice);
|
|
4115
4143
|
init(_data?: any): void;
|
|
4116
4144
|
static fromJS(data: any): Invoice;
|
|
4117
4145
|
toJSON(data?: any): any;
|
|
4118
4146
|
}
|
|
4147
|
+
/** This class represents an invoice */
|
|
4119
4148
|
export interface IInvoice {
|
|
4149
|
+
/** The number of the invoice */
|
|
4120
4150
|
invoiceNumber?: string | undefined;
|
|
4151
|
+
/** The date of the invoice */
|
|
4121
4152
|
invoiceDate?: Date | undefined;
|
|
4153
|
+
/** The type of the invoice */
|
|
4122
4154
|
invoiceType?: InvoiceType | undefined;
|
|
4155
|
+
/** The three letter ISO currency code */
|
|
4123
4156
|
currencyCode?: string | undefined;
|
|
4157
|
+
/** Until when the payment is due */
|
|
4124
4158
|
paymentDueDate?: Date | undefined;
|
|
4159
|
+
/** An object holding reference used in this invoice */
|
|
4125
4160
|
references?: IReferences | undefined;
|
|
4161
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4126
4162
|
paymentTerms?: string | undefined;
|
|
4163
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
4127
4164
|
previousInvoices?: IPreviousInvoice[] | undefined;
|
|
4165
|
+
/** Information about the buyer */
|
|
4128
4166
|
buyer?: IOrganization | undefined;
|
|
4167
|
+
/** Information about the seller */
|
|
4129
4168
|
seller?: IOrganization | undefined;
|
|
4169
|
+
/** A payee is someone who receives the payment that is different from the seller */
|
|
4130
4170
|
payee?: IPayee | undefined;
|
|
4171
|
+
/** If present, this is an unstructured text that can be used to give additional information
|
|
4172
|
+
about the invoice. */
|
|
4131
4173
|
invoiceNotes?: IInvoiceNote[] | undefined;
|
|
4174
|
+
/** The period during which the services or goods were delivered */
|
|
4132
4175
|
invoicePeriod?: IInvoicePeriod | undefined;
|
|
4176
|
+
/** Totals for the invoice */
|
|
4133
4177
|
totals?: IInvoiceTotals | undefined;
|
|
4178
|
+
/** Instructions how to perform the payment */
|
|
4134
4179
|
paymentInstructions?: IPaymentInstructions | undefined;
|
|
4180
|
+
/** Attached documents to the invoice */
|
|
4135
4181
|
documents?: ISupportingDocument[] | undefined;
|
|
4182
|
+
/** This is used to list VAT by category, e.g. for invoices
|
|
4183
|
+
where parts are in different VAT categories */
|
|
4136
4184
|
vatBreakdown?: IVatBreakdown[] | undefined;
|
|
4185
|
+
/** Allowances / deductions on the invoice */
|
|
4137
4186
|
allowances?: IInvoiceAllowance[] | undefined;
|
|
4187
|
+
/** Charges / additional costs on the invoice */
|
|
4138
4188
|
charges?: IInvoiceCharge[] | undefined;
|
|
4189
|
+
/** Single line items in the invoice */
|
|
4139
4190
|
lineItems?: IInvoiceLineItem[] | undefined;
|
|
4191
|
+
/** The source type from which the invoice was created */
|
|
4140
4192
|
sourceType: SourceType;
|
|
4141
4193
|
}
|
|
4194
|
+
/** Type of the invoice */
|
|
4142
4195
|
export declare enum InvoiceType {
|
|
4143
4196
|
PartialInvoice = "PartialInvoice",
|
|
4144
4197
|
CommercialInvoice = "CommercialInvoice",
|
|
@@ -4149,184 +4202,321 @@ export declare enum InvoiceType {
|
|
|
4149
4202
|
PartialFinalConstructionInvoice = "PartialFinalConstructionInvoice",
|
|
4150
4203
|
FinalConstructionInvoice = "FinalConstructionInvoice"
|
|
4151
4204
|
}
|
|
4205
|
+
/** This class holds typical references used in an invoice */
|
|
4152
4206
|
export declare class References implements IReferences {
|
|
4207
|
+
/** An internal reference used by the buyer */
|
|
4153
4208
|
buyerReference?: string | undefined;
|
|
4209
|
+
/** Reference to a project */
|
|
4154
4210
|
projectReference?: string | undefined;
|
|
4211
|
+
/** Reference to a contract */
|
|
4155
4212
|
contractReference?: string | undefined;
|
|
4213
|
+
/** Reference to a purchase order created by the buyer */
|
|
4156
4214
|
purchaseOrderReference?: string | undefined;
|
|
4215
|
+
/** Reference to a sales order created by the seller */
|
|
4157
4216
|
salesOrderReference?: string | undefined;
|
|
4217
|
+
/** Reference to a delivery note */
|
|
4158
4218
|
receivingAdviceReference?: string | undefined;
|
|
4219
|
+
/** Reference to a dispatch advice */
|
|
4159
4220
|
dispatchAdviceReference?: string | undefined;
|
|
4221
|
+
/** Reference to a tender or lot */
|
|
4160
4222
|
tenderOrLotReference?: string | undefined;
|
|
4223
|
+
/** Reference to a custom item, e.g. a phone number, person,
|
|
4224
|
+
contract or anything that would identify the invoice in the buyer's system */
|
|
4161
4225
|
invoicedObjectIdentifier?: string | undefined;
|
|
4162
4226
|
constructor(data?: IReferences);
|
|
4163
4227
|
init(_data?: any): void;
|
|
4164
4228
|
static fromJS(data: any): References;
|
|
4165
4229
|
toJSON(data?: any): any;
|
|
4166
4230
|
}
|
|
4231
|
+
/** This class holds typical references used in an invoice */
|
|
4167
4232
|
export interface IReferences {
|
|
4233
|
+
/** An internal reference used by the buyer */
|
|
4168
4234
|
buyerReference?: string | undefined;
|
|
4235
|
+
/** Reference to a project */
|
|
4169
4236
|
projectReference?: string | undefined;
|
|
4237
|
+
/** Reference to a contract */
|
|
4170
4238
|
contractReference?: string | undefined;
|
|
4239
|
+
/** Reference to a purchase order created by the buyer */
|
|
4171
4240
|
purchaseOrderReference?: string | undefined;
|
|
4241
|
+
/** Reference to a sales order created by the seller */
|
|
4172
4242
|
salesOrderReference?: string | undefined;
|
|
4243
|
+
/** Reference to a delivery note */
|
|
4173
4244
|
receivingAdviceReference?: string | undefined;
|
|
4245
|
+
/** Reference to a dispatch advice */
|
|
4174
4246
|
dispatchAdviceReference?: string | undefined;
|
|
4247
|
+
/** Reference to a tender or lot */
|
|
4175
4248
|
tenderOrLotReference?: string | undefined;
|
|
4249
|
+
/** Reference to a custom item, e.g. a phone number, person,
|
|
4250
|
+
contract or anything that would identify the invoice in the buyer's system */
|
|
4176
4251
|
invoicedObjectIdentifier?: string | undefined;
|
|
4177
4252
|
}
|
|
4253
|
+
/** References to previous invoices */
|
|
4178
4254
|
export declare class PreviousInvoice implements IPreviousInvoice {
|
|
4255
|
+
/** The date of the previous invoice */
|
|
4179
4256
|
invoiceDate?: Date | undefined;
|
|
4257
|
+
/** The number of the previous invoice */
|
|
4180
4258
|
invoiceNumber: string;
|
|
4181
4259
|
constructor(data?: IPreviousInvoice);
|
|
4182
4260
|
init(_data?: any): void;
|
|
4183
4261
|
static fromJS(data: any): PreviousInvoice;
|
|
4184
4262
|
toJSON(data?: any): any;
|
|
4185
4263
|
}
|
|
4264
|
+
/** References to previous invoices */
|
|
4186
4265
|
export interface IPreviousInvoice {
|
|
4266
|
+
/** The date of the previous invoice */
|
|
4187
4267
|
invoiceDate?: Date | undefined;
|
|
4268
|
+
/** The number of the previous invoice */
|
|
4188
4269
|
invoiceNumber: string;
|
|
4189
4270
|
}
|
|
4271
|
+
/** Represents an organization, e.g. a buyer or a seller */
|
|
4190
4272
|
export declare class Organization implements IOrganization {
|
|
4273
|
+
/** The name of the organization */
|
|
4191
4274
|
name?: string | undefined;
|
|
4275
|
+
/** The VAT ID for the organization */
|
|
4192
4276
|
vatId?: string | undefined;
|
|
4277
|
+
/** An email address for the organization */
|
|
4193
4278
|
email?: string | undefined;
|
|
4279
|
+
/** The name of a contact person */
|
|
4194
4280
|
contactPersonName?: string | undefined;
|
|
4281
|
+
/** The phone of a contact person */
|
|
4195
4282
|
contactPersonPhone?: string | undefined;
|
|
4283
|
+
/** The email of a contact person */
|
|
4196
4284
|
contactPersonEmail?: string | undefined;
|
|
4285
|
+
/** The address of the organization */
|
|
4197
4286
|
address?: string | undefined;
|
|
4287
|
+
/** The city of the organization */
|
|
4198
4288
|
city?: string | undefined;
|
|
4289
|
+
/** The zip code of the organization */
|
|
4199
4290
|
zipCode?: string | undefined;
|
|
4291
|
+
/** The ISO 3166-1 2 letter country code */
|
|
4200
4292
|
countryCode?: string | undefined;
|
|
4293
|
+
/** The state of the organization, e.g. a federal state in Germany */
|
|
4201
4294
|
state?: string | undefined;
|
|
4202
4295
|
constructor(data?: IOrganization);
|
|
4203
4296
|
init(_data?: any): void;
|
|
4204
4297
|
static fromJS(data: any): Organization;
|
|
4205
4298
|
toJSON(data?: any): any;
|
|
4206
4299
|
}
|
|
4300
|
+
/** Represents an organization, e.g. a buyer or a seller */
|
|
4207
4301
|
export interface IOrganization {
|
|
4302
|
+
/** The name of the organization */
|
|
4208
4303
|
name?: string | undefined;
|
|
4304
|
+
/** The VAT ID for the organization */
|
|
4209
4305
|
vatId?: string | undefined;
|
|
4306
|
+
/** An email address for the organization */
|
|
4210
4307
|
email?: string | undefined;
|
|
4308
|
+
/** The name of a contact person */
|
|
4211
4309
|
contactPersonName?: string | undefined;
|
|
4310
|
+
/** The phone of a contact person */
|
|
4212
4311
|
contactPersonPhone?: string | undefined;
|
|
4312
|
+
/** The email of a contact person */
|
|
4213
4313
|
contactPersonEmail?: string | undefined;
|
|
4314
|
+
/** The address of the organization */
|
|
4214
4315
|
address?: string | undefined;
|
|
4316
|
+
/** The city of the organization */
|
|
4215
4317
|
city?: string | undefined;
|
|
4318
|
+
/** The zip code of the organization */
|
|
4216
4319
|
zipCode?: string | undefined;
|
|
4320
|
+
/** The ISO 3166-1 2 letter country code */
|
|
4217
4321
|
countryCode?: string | undefined;
|
|
4322
|
+
/** The state of the organization, e.g. a federal state in Germany */
|
|
4218
4323
|
state?: string | undefined;
|
|
4219
4324
|
}
|
|
4325
|
+
/** Represents a payee, meaning someone that receives the payment */
|
|
4220
4326
|
export declare class Payee implements IPayee {
|
|
4327
|
+
/** The name of the payee */
|
|
4221
4328
|
name?: string | undefined;
|
|
4329
|
+
/** The identifier of the payee */
|
|
4222
4330
|
identifier?: string | undefined;
|
|
4331
|
+
/** A registered identifier for the payee, e.g. a VAT ID
|
|
4332
|
+
or Tax ID */
|
|
4223
4333
|
legalRegistrationIdentifier?: string | undefined;
|
|
4224
4334
|
constructor(data?: IPayee);
|
|
4225
4335
|
init(_data?: any): void;
|
|
4226
4336
|
static fromJS(data: any): Payee;
|
|
4227
4337
|
toJSON(data?: any): any;
|
|
4228
4338
|
}
|
|
4339
|
+
/** Represents a payee, meaning someone that receives the payment */
|
|
4229
4340
|
export interface IPayee {
|
|
4341
|
+
/** The name of the payee */
|
|
4230
4342
|
name?: string | undefined;
|
|
4343
|
+
/** The identifier of the payee */
|
|
4231
4344
|
identifier?: string | undefined;
|
|
4345
|
+
/** A registered identifier for the payee, e.g. a VAT ID
|
|
4346
|
+
or Tax ID */
|
|
4232
4347
|
legalRegistrationIdentifier?: string | undefined;
|
|
4233
4348
|
}
|
|
4349
|
+
/** Represents a note / text in an invoice */
|
|
4234
4350
|
export declare class InvoiceNote implements IInvoiceNote {
|
|
4351
|
+
/** Short summary / heading */
|
|
4235
4352
|
shortText?: string | undefined;
|
|
4353
|
+
/** Explanation of this note */
|
|
4236
4354
|
longText?: string | undefined;
|
|
4237
4355
|
constructor(data?: IInvoiceNote);
|
|
4238
4356
|
init(_data?: any): void;
|
|
4239
4357
|
static fromJS(data: any): InvoiceNote;
|
|
4240
4358
|
toJSON(data?: any): any;
|
|
4241
4359
|
}
|
|
4360
|
+
/** Represents a note / text in an invoice */
|
|
4242
4361
|
export interface IInvoiceNote {
|
|
4362
|
+
/** Short summary / heading */
|
|
4243
4363
|
shortText?: string | undefined;
|
|
4364
|
+
/** Explanation of this note */
|
|
4244
4365
|
longText?: string | undefined;
|
|
4245
4366
|
}
|
|
4367
|
+
/** Represents an invoice period with start and end dates */
|
|
4246
4368
|
export declare class InvoicePeriod implements IInvoicePeriod {
|
|
4369
|
+
/** The start date */
|
|
4247
4370
|
start?: Date | undefined;
|
|
4371
|
+
/** The end date */
|
|
4248
4372
|
end?: Date | undefined;
|
|
4249
4373
|
constructor(data?: IInvoicePeriod);
|
|
4250
4374
|
init(_data?: any): void;
|
|
4251
4375
|
static fromJS(data: any): InvoicePeriod;
|
|
4252
4376
|
toJSON(data?: any): any;
|
|
4253
4377
|
}
|
|
4378
|
+
/** Represents an invoice period with start and end dates */
|
|
4254
4379
|
export interface IInvoicePeriod {
|
|
4380
|
+
/** The start date */
|
|
4255
4381
|
start?: Date | undefined;
|
|
4382
|
+
/** The end date */
|
|
4256
4383
|
end?: Date | undefined;
|
|
4257
4384
|
}
|
|
4385
|
+
/** Totals for the invoice */
|
|
4258
4386
|
export declare class InvoiceTotals implements IInvoiceTotals {
|
|
4387
|
+
/** Sum of all invoice items in net. */
|
|
4259
4388
|
totalNet?: number | undefined;
|
|
4389
|
+
/** This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice */
|
|
4260
4390
|
totalAllowances?: number | undefined;
|
|
4391
|
+
/** This is the sum of all charges in the invoice, except VAT. For example, late
|
|
4392
|
+
fees or surcharges. */
|
|
4261
4393
|
totalCharges?: number | undefined;
|
|
4394
|
+
/** This is the total net value of the invoice after applied allowances and charges,
|
|
4395
|
+
meaning the actual net sum to be paid. */
|
|
4262
4396
|
totalAfterDeductions?: number | undefined;
|
|
4397
|
+
/** The total amount of VAT in the invoice. */
|
|
4263
4398
|
totalVatAmount?: number | undefined;
|
|
4399
|
+
/** The total gross amount of the invoice, including all taxes and deductions. */
|
|
4264
4400
|
totalGross?: number | undefined;
|
|
4401
|
+
/** The total amount that has already been paid for this invoice, e.g. used when
|
|
4402
|
+
previous invoice sums are included here that have already been paid. */
|
|
4265
4403
|
alreadyPaidTotal?: number | undefined;
|
|
4404
|
+
/** The sum that needs to be paid for this invoice. This is the total gross amount
|
|
4405
|
+
minus the already paid amount. */
|
|
4266
4406
|
totalToBePaid?: number | undefined;
|
|
4267
4407
|
constructor(data?: IInvoiceTotals);
|
|
4268
4408
|
init(_data?: any): void;
|
|
4269
4409
|
static fromJS(data: any): InvoiceTotals;
|
|
4270
4410
|
toJSON(data?: any): any;
|
|
4271
4411
|
}
|
|
4412
|
+
/** Totals for the invoice */
|
|
4272
4413
|
export interface IInvoiceTotals {
|
|
4414
|
+
/** Sum of all invoice items in net. */
|
|
4273
4415
|
totalNet?: number | undefined;
|
|
4416
|
+
/** This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice */
|
|
4274
4417
|
totalAllowances?: number | undefined;
|
|
4418
|
+
/** This is the sum of all charges in the invoice, except VAT. For example, late
|
|
4419
|
+
fees or surcharges. */
|
|
4275
4420
|
totalCharges?: number | undefined;
|
|
4421
|
+
/** This is the total net value of the invoice after applied allowances and charges,
|
|
4422
|
+
meaning the actual net sum to be paid. */
|
|
4276
4423
|
totalAfterDeductions?: number | undefined;
|
|
4424
|
+
/** The total amount of VAT in the invoice. */
|
|
4277
4425
|
totalVatAmount?: number | undefined;
|
|
4426
|
+
/** The total gross amount of the invoice, including all taxes and deductions. */
|
|
4278
4427
|
totalGross?: number | undefined;
|
|
4428
|
+
/** The total amount that has already been paid for this invoice, e.g. used when
|
|
4429
|
+
previous invoice sums are included here that have already been paid. */
|
|
4279
4430
|
alreadyPaidTotal?: number | undefined;
|
|
4431
|
+
/** The sum that needs to be paid for this invoice. This is the total gross amount
|
|
4432
|
+
minus the already paid amount. */
|
|
4280
4433
|
totalToBePaid?: number | undefined;
|
|
4281
4434
|
}
|
|
4435
|
+
/** Instructions how payment for an invoice should be provided. */
|
|
4282
4436
|
export declare class PaymentInstructions implements IPaymentInstructions {
|
|
4437
|
+
/** Additional text to describe the payment instructions. */
|
|
4283
4438
|
description?: string | undefined;
|
|
4439
|
+
/** This should be a code according to UN/ECE 4461
|
|
4440
|
+
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
4441
|
+
and code "30" means non-SEPA Credit Transfer. */
|
|
4284
4442
|
paymentTypeCode?: string | undefined;
|
|
4443
|
+
/** A list of payment means that can be used to pay the invoice. */
|
|
4285
4444
|
paymentMeans?: PaymentMeans[] | undefined;
|
|
4286
4445
|
constructor(data?: IPaymentInstructions);
|
|
4287
4446
|
init(_data?: any): void;
|
|
4288
4447
|
static fromJS(data: any): PaymentInstructions;
|
|
4289
4448
|
toJSON(data?: any): any;
|
|
4290
4449
|
}
|
|
4450
|
+
/** Instructions how payment for an invoice should be provided. */
|
|
4291
4451
|
export interface IPaymentInstructions {
|
|
4452
|
+
/** Additional text to describe the payment instructions. */
|
|
4292
4453
|
description?: string | undefined;
|
|
4454
|
+
/** This should be a code according to UN/ECE 4461
|
|
4455
|
+
to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
|
|
4456
|
+
and code "30" means non-SEPA Credit Transfer. */
|
|
4293
4457
|
paymentTypeCode?: string | undefined;
|
|
4458
|
+
/** A list of payment means that can be used to pay the invoice. */
|
|
4294
4459
|
paymentMeans?: IPaymentMeans[] | undefined;
|
|
4295
4460
|
}
|
|
4461
|
+
/** Represents a payment means for an invoice */
|
|
4296
4462
|
export declare class PaymentMeans implements IPaymentMeans {
|
|
4463
|
+
/** This is typically the IBAN or account number */
|
|
4297
4464
|
accountIdentifier?: string | undefined;
|
|
4465
|
+
/** The name for the account, typically the name of the owner for
|
|
4466
|
+
a bank account. */
|
|
4298
4467
|
accountName?: string | undefined;
|
|
4468
|
+
/** This can be the BIC */
|
|
4299
4469
|
serviceProviderIdentifier?: string | undefined;
|
|
4300
4470
|
constructor(data?: IPaymentMeans);
|
|
4301
4471
|
init(_data?: any): void;
|
|
4302
4472
|
static fromJS(data: any): PaymentMeans;
|
|
4303
4473
|
toJSON(data?: any): any;
|
|
4304
4474
|
}
|
|
4475
|
+
/** Represents a payment means for an invoice */
|
|
4305
4476
|
export interface IPaymentMeans {
|
|
4477
|
+
/** This is typically the IBAN or account number */
|
|
4306
4478
|
accountIdentifier?: string | undefined;
|
|
4479
|
+
/** The name for the account, typically the name of the owner for
|
|
4480
|
+
a bank account. */
|
|
4307
4481
|
accountName?: string | undefined;
|
|
4482
|
+
/** This can be the BIC */
|
|
4308
4483
|
serviceProviderIdentifier?: string | undefined;
|
|
4309
4484
|
}
|
|
4485
|
+
/** Represents a document / attachment that is included with the invoice */
|
|
4310
4486
|
export declare class SupportingDocument implements ISupportingDocument {
|
|
4487
|
+
/** This is typically an id or a name */
|
|
4311
4488
|
documentReference?: string | undefined;
|
|
4489
|
+
/** A description of the document */
|
|
4312
4490
|
description?: string | undefined;
|
|
4491
|
+
/** A link to the document in case this is an external reference */
|
|
4313
4492
|
externalDocumentUrl?: string | undefined;
|
|
4493
|
+
/** The document in base64 encoded form as binary data */
|
|
4314
4494
|
documentBase64?: string | undefined;
|
|
4495
|
+
/** This should be present if DocumentBase64 is set. */
|
|
4315
4496
|
fileName?: string | undefined;
|
|
4497
|
+
/** The type of the document */
|
|
4316
4498
|
documentMimeType: AttachmentMimeType;
|
|
4317
4499
|
constructor(data?: ISupportingDocument);
|
|
4318
4500
|
init(_data?: any): void;
|
|
4319
4501
|
static fromJS(data: any): SupportingDocument;
|
|
4320
4502
|
toJSON(data?: any): any;
|
|
4321
4503
|
}
|
|
4504
|
+
/** Represents a document / attachment that is included with the invoice */
|
|
4322
4505
|
export interface ISupportingDocument {
|
|
4506
|
+
/** This is typically an id or a name */
|
|
4323
4507
|
documentReference?: string | undefined;
|
|
4508
|
+
/** A description of the document */
|
|
4324
4509
|
description?: string | undefined;
|
|
4510
|
+
/** A link to the document in case this is an external reference */
|
|
4325
4511
|
externalDocumentUrl?: string | undefined;
|
|
4512
|
+
/** The document in base64 encoded form as binary data */
|
|
4326
4513
|
documentBase64?: string | undefined;
|
|
4514
|
+
/** This should be present if DocumentBase64 is set. */
|
|
4327
4515
|
fileName?: string | undefined;
|
|
4516
|
+
/** The type of the document */
|
|
4328
4517
|
documentMimeType: AttachmentMimeType;
|
|
4329
4518
|
}
|
|
4519
|
+
/** Describes a mimne type of a document */
|
|
4330
4520
|
export declare enum AttachmentMimeType {
|
|
4331
4521
|
Unknown = "Unknown",
|
|
4332
4522
|
Pdf = "Pdf",
|
|
@@ -4336,26 +4526,47 @@ export declare enum AttachmentMimeType {
|
|
|
4336
4526
|
Excel = "Excel",
|
|
4337
4527
|
OpenOfficeSpreadsheet = "OpenOfficeSpreadsheet"
|
|
4338
4528
|
}
|
|
4529
|
+
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
4339
4530
|
export declare class VatBreakdown implements IVatBreakdown {
|
|
4531
|
+
/** The total net amount of this VAT category */
|
|
4340
4532
|
netTaxableAmount?: number | undefined;
|
|
4533
|
+
/** The total VAT */
|
|
4341
4534
|
vatAmount?: number | undefined;
|
|
4535
|
+
/** The category of the VAT */
|
|
4342
4536
|
vatCategory: VatCategory;
|
|
4537
|
+
/** The actual tax rate as a decimal value,
|
|
4538
|
+
e.g. 19% would be 0.19 */
|
|
4343
4539
|
taxRate?: number | undefined;
|
|
4540
|
+
/** If the VAT is exempt, there should be a description here.
|
|
4541
|
+
For example, in reverse charge scenarios, this text
|
|
4542
|
+
should contain a reference to "Reverse charge according to ...". */
|
|
4344
4543
|
vatExemptionReasonText?: string | undefined;
|
|
4544
|
+
/** A code from the VAT exemption reason code list(VATEX)“ */
|
|
4345
4545
|
vatExemptionReasonCode?: string | undefined;
|
|
4346
4546
|
constructor(data?: IVatBreakdown);
|
|
4347
4547
|
init(_data?: any): void;
|
|
4348
4548
|
static fromJS(data: any): VatBreakdown;
|
|
4349
4549
|
toJSON(data?: any): any;
|
|
4350
4550
|
}
|
|
4551
|
+
/** Describes the VAT breakdown for an invoice in a single VAT category */
|
|
4351
4552
|
export interface IVatBreakdown {
|
|
4553
|
+
/** The total net amount of this VAT category */
|
|
4352
4554
|
netTaxableAmount?: number | undefined;
|
|
4555
|
+
/** The total VAT */
|
|
4353
4556
|
vatAmount?: number | undefined;
|
|
4557
|
+
/** The category of the VAT */
|
|
4354
4558
|
vatCategory: VatCategory;
|
|
4559
|
+
/** The actual tax rate as a decimal value,
|
|
4560
|
+
e.g. 19% would be 0.19 */
|
|
4355
4561
|
taxRate?: number | undefined;
|
|
4562
|
+
/** If the VAT is exempt, there should be a description here.
|
|
4563
|
+
For example, in reverse charge scenarios, this text
|
|
4564
|
+
should contain a reference to "Reverse charge according to ...". */
|
|
4356
4565
|
vatExemptionReasonText?: string | undefined;
|
|
4566
|
+
/** A code from the VAT exemption reason code list(VATEX)“ */
|
|
4357
4567
|
vatExemptionReasonCode?: string | undefined;
|
|
4358
4568
|
}
|
|
4569
|
+
/** The category used in a VatBreakdown"/> */
|
|
4359
4570
|
export declare enum VatCategory {
|
|
4360
4571
|
Unknown = "Unknown",
|
|
4361
4572
|
StandardRate = "StandardRate",
|
|
@@ -4368,221 +4579,414 @@ export declare enum VatCategory {
|
|
|
4368
4579
|
CanaryIslandsGeneralIndirectTax = "CanaryIslandsGeneralIndirectTax",
|
|
4369
4580
|
TaxInCeutaAndMelilla = "TaxInCeutaAndMelilla"
|
|
4370
4581
|
}
|
|
4582
|
+
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
4371
4583
|
export declare class InvoiceAllowance implements IInvoiceAllowance {
|
|
4584
|
+
/** The net amount of the allowance */
|
|
4372
4585
|
netAmount?: number | undefined;
|
|
4586
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4587
|
+
and give the base amount that is being used for the calculation */
|
|
4373
4588
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4589
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4590
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4374
4591
|
relativeAllowancePercentage?: number | undefined;
|
|
4592
|
+
/** The VAT category for the allowance */
|
|
4375
4593
|
vatCategory: VatCategory;
|
|
4594
|
+
/** The actual tax rate as a decimal value,
|
|
4595
|
+
meaning 19% would be 0.19 */
|
|
4376
4596
|
vatRate?: number | undefined;
|
|
4597
|
+
/** A description of the allowance. */
|
|
4377
4598
|
reason?: string | undefined;
|
|
4599
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
4378
4600
|
reasonCode?: string | undefined;
|
|
4379
4601
|
constructor(data?: IInvoiceAllowance);
|
|
4380
4602
|
init(_data?: any): void;
|
|
4381
4603
|
static fromJS(data: any): InvoiceAllowance;
|
|
4382
4604
|
toJSON(data?: any): any;
|
|
4383
4605
|
}
|
|
4606
|
+
/** This describes an allowance in an invoice, which is a deduction from the total amount */
|
|
4384
4607
|
export interface IInvoiceAllowance {
|
|
4608
|
+
/** The net amount of the allowance */
|
|
4385
4609
|
netAmount?: number | undefined;
|
|
4610
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4611
|
+
and give the base amount that is being used for the calculation */
|
|
4386
4612
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4613
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4614
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4387
4615
|
relativeAllowancePercentage?: number | undefined;
|
|
4616
|
+
/** The VAT category for the allowance */
|
|
4388
4617
|
vatCategory: VatCategory;
|
|
4618
|
+
/** The actual tax rate as a decimal value,
|
|
4619
|
+
meaning 19% would be 0.19 */
|
|
4389
4620
|
vatRate?: number | undefined;
|
|
4621
|
+
/** A description of the allowance. */
|
|
4390
4622
|
reason?: string | undefined;
|
|
4623
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
4391
4624
|
reasonCode?: string | undefined;
|
|
4392
4625
|
}
|
|
4626
|
+
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
4393
4627
|
export declare class InvoiceCharge implements IInvoiceCharge {
|
|
4628
|
+
/** The net amount of the charge */
|
|
4394
4629
|
netAmount?: number | undefined;
|
|
4630
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4631
|
+
and give the base amount that is being used for the calculation */
|
|
4395
4632
|
relativeChargeBaseAmount?: number | undefined;
|
|
4633
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4634
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4396
4635
|
relativeChargePercentage?: number | undefined;
|
|
4636
|
+
/** The VAT category for the charge */
|
|
4397
4637
|
vatCategory: VatCategory;
|
|
4638
|
+
/** The actual tax rate as a decimal value,
|
|
4639
|
+
meaning 19% would be 0.19 */
|
|
4398
4640
|
vatRate?: number | undefined;
|
|
4641
|
+
/** A description of the charge. */
|
|
4399
4642
|
reason?: string | undefined;
|
|
4643
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
4400
4644
|
reasonCode?: string | undefined;
|
|
4401
4645
|
constructor(data?: IInvoiceCharge);
|
|
4402
4646
|
init(_data?: any): void;
|
|
4403
4647
|
static fromJS(data: any): InvoiceCharge;
|
|
4404
4648
|
toJSON(data?: any): any;
|
|
4405
4649
|
}
|
|
4650
|
+
/** This describes an charge in an invoice, which is a surcharge to the total amount */
|
|
4406
4651
|
export interface IInvoiceCharge {
|
|
4652
|
+
/** The net amount of the charge */
|
|
4407
4653
|
netAmount?: number | undefined;
|
|
4654
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4655
|
+
and give the base amount that is being used for the calculation */
|
|
4408
4656
|
relativeChargeBaseAmount?: number | undefined;
|
|
4657
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4658
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4409
4659
|
relativeChargePercentage?: number | undefined;
|
|
4660
|
+
/** The VAT category for the charge */
|
|
4410
4661
|
vatCategory: VatCategory;
|
|
4662
|
+
/** The actual tax rate as a decimal value,
|
|
4663
|
+
meaning 19% would be 0.19 */
|
|
4411
4664
|
vatRate?: number | undefined;
|
|
4665
|
+
/** A description of the charge. */
|
|
4412
4666
|
reason?: string | undefined;
|
|
4667
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
4413
4668
|
reasonCode?: string | undefined;
|
|
4414
4669
|
}
|
|
4670
|
+
/** Represents a single invoice line item */
|
|
4415
4671
|
export declare class InvoiceLineItem implements IInvoiceLineItem {
|
|
4672
|
+
/** An unique identifier for the line item */
|
|
4416
4673
|
identifier?: string | undefined;
|
|
4674
|
+
/** An unstructured note to classify line items */
|
|
4417
4675
|
note?: string | undefined;
|
|
4676
|
+
/** A seller-defined object identifier for this line item,
|
|
4677
|
+
meaning an identifier for the actual line. This could be
|
|
4678
|
+
a numbering sequence or a reference to a product. */
|
|
4418
4679
|
objectIdentifier?: string | undefined;
|
|
4680
|
+
/** The actual invoiced quantity of the line item */
|
|
4419
4681
|
quantity?: number | undefined;
|
|
4682
|
+
/** A code for the unit of the quantity. This should be a code as defined
|
|
4683
|
+
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
4684
|
+
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
4685
|
+
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names) */
|
|
4420
4686
|
unitCode?: string | undefined;
|
|
4687
|
+
/** The net amount for this line item */
|
|
4421
4688
|
netAmount?: number | undefined;
|
|
4689
|
+
/** A reference to an item in the buyers purachase order */
|
|
4422
4690
|
purchaseOrderReference?: string | undefined;
|
|
4691
|
+
/** Information about the invoice period for this line item. */
|
|
4423
4692
|
lineItemPeriod?: InvoicePeriod | undefined;
|
|
4693
|
+
/** Allowances specific to this line item */
|
|
4424
4694
|
allowances?: LineItemAllowance[] | undefined;
|
|
4695
|
+
/** charges specific to this line item */
|
|
4425
4696
|
charges?: LineItemCharge[] | undefined;
|
|
4697
|
+
/** Price details for this line item. */
|
|
4426
4698
|
priceDetails?: LineItemPriceDetail | undefined;
|
|
4699
|
+
/** VAT information for this line item */
|
|
4427
4700
|
vatInformation?: LineItemVatInformation[] | undefined;
|
|
4701
|
+
/** Information about this line item */
|
|
4428
4702
|
itemInformation?: LineItemInformation | undefined;
|
|
4703
|
+
/** Line items can be nested, in which case this property holds the sub items */
|
|
4429
4704
|
subItems?: InvoiceLineItem[] | undefined;
|
|
4430
4705
|
constructor(data?: IInvoiceLineItem);
|
|
4431
4706
|
init(_data?: any): void;
|
|
4432
4707
|
static fromJS(data: any): InvoiceLineItem;
|
|
4433
4708
|
toJSON(data?: any): any;
|
|
4434
4709
|
}
|
|
4710
|
+
/** Represents a single invoice line item */
|
|
4435
4711
|
export interface IInvoiceLineItem {
|
|
4712
|
+
/** An unique identifier for the line item */
|
|
4436
4713
|
identifier?: string | undefined;
|
|
4714
|
+
/** An unstructured note to classify line items */
|
|
4437
4715
|
note?: string | undefined;
|
|
4716
|
+
/** A seller-defined object identifier for this line item,
|
|
4717
|
+
meaning an identifier for the actual line. This could be
|
|
4718
|
+
a numbering sequence or a reference to a product. */
|
|
4438
4719
|
objectIdentifier?: string | undefined;
|
|
4720
|
+
/** The actual invoiced quantity of the line item */
|
|
4439
4721
|
quantity?: number | undefined;
|
|
4722
|
+
/** A code for the unit of the quantity. This should be a code as defined
|
|
4723
|
+
in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
|
|
4724
|
+
International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
|
|
4725
|
+
Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names) */
|
|
4440
4726
|
unitCode?: string | undefined;
|
|
4727
|
+
/** The net amount for this line item */
|
|
4441
4728
|
netAmount?: number | undefined;
|
|
4729
|
+
/** A reference to an item in the buyers purachase order */
|
|
4442
4730
|
purchaseOrderReference?: string | undefined;
|
|
4731
|
+
/** Information about the invoice period for this line item. */
|
|
4443
4732
|
lineItemPeriod?: IInvoicePeriod | undefined;
|
|
4733
|
+
/** Allowances specific to this line item */
|
|
4444
4734
|
allowances?: ILineItemAllowance[] | undefined;
|
|
4735
|
+
/** charges specific to this line item */
|
|
4445
4736
|
charges?: ILineItemCharge[] | undefined;
|
|
4737
|
+
/** Price details for this line item. */
|
|
4446
4738
|
priceDetails?: ILineItemPriceDetail | undefined;
|
|
4739
|
+
/** VAT information for this line item */
|
|
4447
4740
|
vatInformation?: ILineItemVatInformation[] | undefined;
|
|
4741
|
+
/** Information about this line item */
|
|
4448
4742
|
itemInformation?: ILineItemInformation | undefined;
|
|
4743
|
+
/** Line items can be nested, in which case this property holds the sub items */
|
|
4449
4744
|
subItems?: IInvoiceLineItem[] | undefined;
|
|
4450
4745
|
}
|
|
4746
|
+
/** Allowance for a single line item */
|
|
4451
4747
|
export declare class LineItemAllowance implements ILineItemAllowance {
|
|
4748
|
+
/** The net amount of the allowance */
|
|
4452
4749
|
netAmount?: number | undefined;
|
|
4750
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4751
|
+
and give the base amount that is being used for the calculation */
|
|
4453
4752
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4753
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4754
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4454
4755
|
relativeAllowancePercentage?: number | undefined;
|
|
4756
|
+
/** A description of the allowance. */
|
|
4455
4757
|
reason?: string | undefined;
|
|
4758
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
4456
4759
|
reasonCode?: string | undefined;
|
|
4457
4760
|
constructor(data?: ILineItemAllowance);
|
|
4458
4761
|
init(_data?: any): void;
|
|
4459
4762
|
static fromJS(data: any): LineItemAllowance;
|
|
4460
4763
|
toJSON(data?: any): any;
|
|
4461
4764
|
}
|
|
4765
|
+
/** Allowance for a single line item */
|
|
4462
4766
|
export interface ILineItemAllowance {
|
|
4767
|
+
/** The net amount of the allowance */
|
|
4463
4768
|
netAmount?: number | undefined;
|
|
4769
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4770
|
+
and give the base amount that is being used for the calculation */
|
|
4464
4771
|
relativeAllowanceBaseAmount?: number | undefined;
|
|
4772
|
+
/** If this is a relative / percentage allowance, this should be set
|
|
4773
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4465
4774
|
relativeAllowancePercentage?: number | undefined;
|
|
4775
|
+
/** A description of the allowance. */
|
|
4466
4776
|
reason?: string | undefined;
|
|
4777
|
+
/** A reason code for the allowance according to UNTDID 5189. */
|
|
4467
4778
|
reasonCode?: string | undefined;
|
|
4468
4779
|
}
|
|
4780
|
+
/** Charge for a single line item */
|
|
4469
4781
|
export declare class LineItemCharge implements ILineItemCharge {
|
|
4782
|
+
/** The net amount of the charge */
|
|
4470
4783
|
netAmount?: number | undefined;
|
|
4784
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4785
|
+
and give the base amount that is being used for the calculation */
|
|
4471
4786
|
relativeChargeBaseAmount?: number | undefined;
|
|
4787
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4788
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4472
4789
|
relativeChargePercentage?: number | undefined;
|
|
4790
|
+
/** A description of the charge. */
|
|
4473
4791
|
reason?: string | undefined;
|
|
4792
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
4474
4793
|
reasonCode?: string | undefined;
|
|
4475
4794
|
constructor(data?: ILineItemCharge);
|
|
4476
4795
|
init(_data?: any): void;
|
|
4477
4796
|
static fromJS(data: any): LineItemCharge;
|
|
4478
4797
|
toJSON(data?: any): any;
|
|
4479
4798
|
}
|
|
4799
|
+
/** Charge for a single line item */
|
|
4480
4800
|
export interface ILineItemCharge {
|
|
4801
|
+
/** The net amount of the charge */
|
|
4481
4802
|
netAmount?: number | undefined;
|
|
4803
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4804
|
+
and give the base amount that is being used for the calculation */
|
|
4482
4805
|
relativeChargeBaseAmount?: number | undefined;
|
|
4806
|
+
/** If this is a relative / percentage charge, this should be set
|
|
4807
|
+
and be given in decimal representation, meaning 19% would be 0.19 */
|
|
4483
4808
|
relativeChargePercentage?: number | undefined;
|
|
4809
|
+
/** A description of the charge. */
|
|
4484
4810
|
reason?: string | undefined;
|
|
4811
|
+
/** A reason code for the charge according to UNTDID 7161. */
|
|
4485
4812
|
reasonCode?: string | undefined;
|
|
4486
4813
|
}
|
|
4814
|
+
/** Price details about a line item */
|
|
4487
4815
|
export declare class LineItemPriceDetail implements ILineItemPriceDetail {
|
|
4816
|
+
/** The net price of this line item */
|
|
4488
4817
|
netPrice?: number | undefined;
|
|
4489
|
-
discount
|
|
4818
|
+
/** A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
4819
|
+
and the actual invoiced price GrossPrice. */
|
|
4820
|
+
absoluteDiscountPerItem?: number | undefined;
|
|
4821
|
+
/** The gross price of this line item, meaning the price without taxes
|
|
4822
|
+
that will be invoiced */
|
|
4490
4823
|
grossPrice?: number | undefined;
|
|
4824
|
+
/** The quantity for which this price is valid */
|
|
4491
4825
|
baseQuantity?: number | undefined;
|
|
4826
|
+
/** A code representing the unit for the base quantity */
|
|
4492
4827
|
baseQuantityUnitCode?: string | undefined;
|
|
4493
4828
|
constructor(data?: ILineItemPriceDetail);
|
|
4494
4829
|
init(_data?: any): void;
|
|
4495
4830
|
static fromJS(data: any): LineItemPriceDetail;
|
|
4496
4831
|
toJSON(data?: any): any;
|
|
4497
4832
|
}
|
|
4833
|
+
/** Price details about a line item */
|
|
4498
4834
|
export interface ILineItemPriceDetail {
|
|
4835
|
+
/** The net price of this line item */
|
|
4499
4836
|
netPrice?: number | undefined;
|
|
4500
|
-
discount
|
|
4837
|
+
/** A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price)
|
|
4838
|
+
and the actual invoiced price GrossPrice. */
|
|
4839
|
+
absoluteDiscountPerItem?: number | undefined;
|
|
4840
|
+
/** The gross price of this line item, meaning the price without taxes
|
|
4841
|
+
that will be invoiced */
|
|
4501
4842
|
grossPrice?: number | undefined;
|
|
4843
|
+
/** The quantity for which this price is valid */
|
|
4502
4844
|
baseQuantity?: number | undefined;
|
|
4845
|
+
/** A code representing the unit for the base quantity */
|
|
4503
4846
|
baseQuantityUnitCode?: string | undefined;
|
|
4504
4847
|
}
|
|
4848
|
+
/** VAT information for a single line item */
|
|
4505
4849
|
export declare class LineItemVatInformation implements ILineItemVatInformation {
|
|
4850
|
+
/** The VAT category for the charge */
|
|
4506
4851
|
vatCategory: VatCategory;
|
|
4852
|
+
/** The actual tax rate as a decimal value,
|
|
4853
|
+
meaning 19% would be 0.19 */
|
|
4507
4854
|
vatRate?: number | undefined;
|
|
4508
4855
|
constructor(data?: ILineItemVatInformation);
|
|
4509
4856
|
init(_data?: any): void;
|
|
4510
4857
|
static fromJS(data: any): LineItemVatInformation;
|
|
4511
4858
|
toJSON(data?: any): any;
|
|
4512
4859
|
}
|
|
4860
|
+
/** VAT information for a single line item */
|
|
4513
4861
|
export interface ILineItemVatInformation {
|
|
4862
|
+
/** The VAT category for the charge */
|
|
4514
4863
|
vatCategory: VatCategory;
|
|
4864
|
+
/** The actual tax rate as a decimal value,
|
|
4865
|
+
meaning 19% would be 0.19 */
|
|
4515
4866
|
vatRate?: number | undefined;
|
|
4516
4867
|
}
|
|
4868
|
+
/** Information about a single line item */
|
|
4517
4869
|
export declare class LineItemInformation implements ILineItemInformation {
|
|
4870
|
+
/** A name for the line item */
|
|
4518
4871
|
name?: string | undefined;
|
|
4872
|
+
/** A description for the line item */
|
|
4519
4873
|
description?: string | undefined;
|
|
4874
|
+
/** An identifier assigned by the seller, e.g. an internal article number */
|
|
4520
4875
|
sellerIdentifier?: string | undefined;
|
|
4876
|
+
/** An identifier assigned by the buyer, e.g. an internal article number */
|
|
4521
4877
|
buyerIdentifier?: string | undefined;
|
|
4878
|
+
/** A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
4522
4879
|
standardIdentifier?: string | undefined;
|
|
4880
|
+
/** A list of classification identifiers for the line item */
|
|
4523
4881
|
classificationIdentifiers?: string[] | undefined;
|
|
4882
|
+
/** The origin country code according to ISO 3166-1 in 2 letter format */
|
|
4524
4883
|
countryOfOrigin?: string | undefined;
|
|
4884
|
+
/** Optional additional attributes for this line item */
|
|
4525
4885
|
attributes?: LineItemAttribute[] | undefined;
|
|
4526
4886
|
constructor(data?: ILineItemInformation);
|
|
4527
4887
|
init(_data?: any): void;
|
|
4528
4888
|
static fromJS(data: any): LineItemInformation;
|
|
4529
4889
|
toJSON(data?: any): any;
|
|
4530
4890
|
}
|
|
4891
|
+
/** Information about a single line item */
|
|
4531
4892
|
export interface ILineItemInformation {
|
|
4893
|
+
/** A name for the line item */
|
|
4532
4894
|
name?: string | undefined;
|
|
4895
|
+
/** A description for the line item */
|
|
4533
4896
|
description?: string | undefined;
|
|
4897
|
+
/** An identifier assigned by the seller, e.g. an internal article number */
|
|
4534
4898
|
sellerIdentifier?: string | undefined;
|
|
4899
|
+
/** An identifier assigned by the buyer, e.g. an internal article number */
|
|
4535
4900
|
buyerIdentifier?: string | undefined;
|
|
4901
|
+
/** A standard identifier for the line item, e.g. an EAN or a GTIN */
|
|
4536
4902
|
standardIdentifier?: string | undefined;
|
|
4903
|
+
/** A list of classification identifiers for the line item */
|
|
4537
4904
|
classificationIdentifiers?: string[] | undefined;
|
|
4905
|
+
/** The origin country code according to ISO 3166-1 in 2 letter format */
|
|
4538
4906
|
countryOfOrigin?: string | undefined;
|
|
4907
|
+
/** Optional additional attributes for this line item */
|
|
4539
4908
|
attributes?: ILineItemAttribute[] | undefined;
|
|
4540
4909
|
}
|
|
4910
|
+
/** A key-value pair for additional information */
|
|
4541
4911
|
export declare class LineItemAttribute implements ILineItemAttribute {
|
|
4912
|
+
/** The key / name of the attribute */
|
|
4542
4913
|
name: string;
|
|
4914
|
+
/** The value of the attribute */
|
|
4543
4915
|
value?: string | undefined;
|
|
4544
4916
|
constructor(data?: ILineItemAttribute);
|
|
4545
4917
|
init(_data?: any): void;
|
|
4546
4918
|
static fromJS(data: any): LineItemAttribute;
|
|
4547
4919
|
toJSON(data?: any): any;
|
|
4548
4920
|
}
|
|
4921
|
+
/** A key-value pair for additional information */
|
|
4549
4922
|
export interface ILineItemAttribute {
|
|
4923
|
+
/** The key / name of the attribute */
|
|
4550
4924
|
name: string;
|
|
4925
|
+
/** The value of the attribute */
|
|
4551
4926
|
value?: string | undefined;
|
|
4552
4927
|
}
|
|
4928
|
+
/** This enum represents the source of an invoice, e.g. from which format it was imported */
|
|
4553
4929
|
export declare enum SourceType {
|
|
4554
4930
|
Self = "Self",
|
|
4555
4931
|
Ubl = "Ubl",
|
|
4556
4932
|
Cii = "Cii"
|
|
4557
4933
|
}
|
|
4934
|
+
/** This is a wrapper class that maps Dangl.AVA projects along with additional required information to create invoices */
|
|
4558
4935
|
export declare class AvaProjectWrapper implements IAvaProjectWrapper {
|
|
4936
|
+
/** The Dangl.AVA.Project from which to convert */
|
|
4559
4937
|
project: ProjectDto;
|
|
4938
|
+
/** The number of the invoice */
|
|
4560
4939
|
invoiceNumber?: string | undefined;
|
|
4940
|
+
/** Attached documents to the invoice */
|
|
4561
4941
|
documents?: SupportingDocument[] | undefined;
|
|
4942
|
+
/** The period during which the services or goods were delivered */
|
|
4562
4943
|
invoicePeriod?: InvoicePeriod | undefined;
|
|
4944
|
+
/** Instructions how to perform the payment */
|
|
4563
4945
|
paymentInstructions?: PaymentInstructions | undefined;
|
|
4946
|
+
/** The type of the invoice */
|
|
4564
4947
|
invoiceType: InvoiceType;
|
|
4948
|
+
/** Until when the payment is due */
|
|
4565
4949
|
paymentDueDate?: Date | undefined;
|
|
4950
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4566
4951
|
paymentTerms?: string | undefined;
|
|
4952
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
4567
4953
|
previousInvoices?: PreviousInvoice[] | undefined;
|
|
4954
|
+
/** If parts of this invoice (or of previous invoices) have already been paid,
|
|
4955
|
+
then this property can be used to specify that some parts of the invoice
|
|
4956
|
+
are already paid and this will be deducted from the to be paid amount. */
|
|
4568
4957
|
alreadyPaidTotalGross: number;
|
|
4958
|
+
/** An object holding reference used in this invoice */
|
|
4569
4959
|
references?: References | undefined;
|
|
4570
4960
|
constructor(data?: IAvaProjectWrapper);
|
|
4571
4961
|
init(_data?: any): void;
|
|
4572
4962
|
static fromJS(data: any): AvaProjectWrapper;
|
|
4573
4963
|
toJSON(data?: any): any;
|
|
4574
4964
|
}
|
|
4965
|
+
/** This is a wrapper class that maps Dangl.AVA projects along with additional required information to create invoices */
|
|
4575
4966
|
export interface IAvaProjectWrapper {
|
|
4967
|
+
/** The Dangl.AVA.Project from which to convert */
|
|
4576
4968
|
project: IProjectDto;
|
|
4969
|
+
/** The number of the invoice */
|
|
4577
4970
|
invoiceNumber?: string | undefined;
|
|
4971
|
+
/** Attached documents to the invoice */
|
|
4578
4972
|
documents?: ISupportingDocument[] | undefined;
|
|
4973
|
+
/** The period during which the services or goods were delivered */
|
|
4579
4974
|
invoicePeriod?: IInvoicePeriod | undefined;
|
|
4975
|
+
/** Instructions how to perform the payment */
|
|
4580
4976
|
paymentInstructions?: IPaymentInstructions | undefined;
|
|
4977
|
+
/** The type of the invoice */
|
|
4581
4978
|
invoiceType: InvoiceType;
|
|
4979
|
+
/** Until when the payment is due */
|
|
4582
4980
|
paymentDueDate?: Date | undefined;
|
|
4981
|
+
/** A text description of payment terms, e.g. cash discounts or payment conditions */
|
|
4583
4982
|
paymentTerms?: string | undefined;
|
|
4983
|
+
/** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
|
|
4584
4984
|
previousInvoices?: IPreviousInvoice[] | undefined;
|
|
4985
|
+
/** If parts of this invoice (or of previous invoices) have already been paid,
|
|
4986
|
+
then this property can be used to specify that some parts of the invoice
|
|
4987
|
+
are already paid and this will be deducted from the to be paid amount. */
|
|
4585
4988
|
alreadyPaidTotalGross: number;
|
|
4989
|
+
/** An object holding reference used in this invoice */
|
|
4586
4990
|
references?: IReferences | undefined;
|
|
4587
4991
|
}
|
|
4588
4992
|
export declare class LoginPost implements ILoginPost {
|