@dangl/angular-ava 1.0.1-beta0011 → 1.0.1-beta0021

package/lib/ava-tree/invoice/invoice-display/invoice-display.component.d.ts

@@ -0,0 +1,54 @@
+import { ITextWordInvoice } from '../../tree/model';
+import { Invoice } from '../../tree/model/invoice-models';
+import * as i0 from "@angular/core";
+export declare class InvoiceDisplayComponent {
+    invoice: import("@angular/core").InputSignal<Invoice>;
+    private _textWords;
+    /**
+     * You can supply a map of strings to be used for the text in the tree. This allows you to translate
+     * the text in the tree to other languages.
+     * {
+     *   invoiceTitle?: string;
+     *   vatId?: string;
+     *   detailsInvoiceNumber?: string;
+     *   detailsInvoiceDate?: string;
+     *   detailsPaymentDueDate?: string;
+     *   detailsCurrencyCode?: string;
+     *   detailsPaymentTerms?: string;
+     *   referencesTopic?: string;
+     *   referencesBuyerReference?: string;
+     *   referencesProjectReference?: string;
+     *   referencesContractReference?: string;
+     *   referencesPurchaseOrderReference?: string;
+     *   referencesSalesOrderReference?: string;
+     *   referencesReceivingAdviceReference?: string;
+     *   referencesDispatchAdviceReference?: string;
+     *   referencesTenderOrLotReference?: string;
+     *   referencesInvoicedObjectIdentifier?: string;
+     *   tableHeadDescription?: string;
+     *   tableHeadQuantity?: string;
+     *   tableHeadUnit?: string;
+     *   tableHeadNetPrice?: string;
+     *   tableHeadNetAmount?: string;
+     *   totalsTopic?: string;
+     *   totalsTotalNet?: string;
+     *   totalsTotalAllowances?: string;
+     *   totalsTotalCharges?: string;
+     *   totalsTotalAfterDeductions?: string;
+     *   totalsTotalVatAmount?: string;
+     *   totalsTotalGross?: string;
+     *   totalsAlreadyPaidTotal?: string;
+     *   totalsTotalToBePaid?: string;
+     *   instructionsTopic?: string;
+     *   instructionsAccountIdentifier?: string;
+     *   instructionsAccountName?: string;
+     *   instructionsServiceProviderIdentifier?: string;
+     *   notesTopic?: string;
+     * }
+     */
+    set textWords(words: ITextWordInvoice | null);
+    get textWords(): ITextWordInvoice | null;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<InvoiceDisplayComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<InvoiceDisplayComponent, "ava-invoice-display", never, { "invoice": { "alias": "invoice"; "required": true; "isSignal": true; }; "textWords": { "alias": "textWords"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/ava-tree/tree/constants/defaultTextWordInvoice.d.ts

@@ -0,0 +1,3 @@
+import { ITextWordInvoice } from '../model';
+export declare const DEFAULT_TEXT_WORD_INVOICE: ITextWordInvoice;
+export declare const germanTextsInvoice: ITextWordInvoice;

package/lib/ava-tree/tree/constants/index.d.ts

@@ -1,4 +1,5 @@
 import { DEFAULT_FILTERS } from './defaultFilters';
+import { DEFAULT_TEXT_WORD_INVOICE, germanTextsInvoice } from './defaultTextWordInvoice';
 import { DEFAULT_TEXT_WORDS } from './defaultTextWords';
 import { defaults } from './defaults';
-export { DEFAULT_FILTERS, DEFAULT_TEXT_WORDS, defaults };
+export { DEFAULT_FILTERS, DEFAULT_TEXT_WORDS, defaults, DEFAULT_TEXT_WORD_INVOICE, germanTextsInvoice };

package/lib/ava-tree/tree/model/index.d.ts

@@ -1,7 +1,8 @@
 import { ExchangePhaseDto, ExecutionDescriptionDto, IElementDto, ItemNumberDto, ItemNumberSchemaTierTypeDto, ItemNumberTypeDto, NoteTextDto, OriginDto, PositionDto, PriceRoundingModeDto, PriceTypeDto, ProjectDto, ServiceSpecificationDto, ServiceSpecificationGroupDto } from './ava-models';
 import { ContextMenuDataType } from './context-menu-data.model';
 import { IFunctionViewLine, IViewLine } from './function-view-line.model';
+import { ITextWordInvoice } from './invoice-words.model';
 import { SelectedElement } from './selecting.model';
 import { TableColumnType } from './tableColumnType';
 import { ModeViewType } from './tree-mode.model';
-export { ProjectDto, ServiceSpecificationDto, IElementDto, PositionDto, ExecutionDescriptionDto, NoteTextDto, ServiceSpecificationGroupDto, ItemNumberDto, SelectedElement, ModeViewType, TableColumnType, IFunctionViewLine, IViewLine, ContextMenuDataType, ExchangePhaseDto, ItemNumberSchemaTierTypeDto, ItemNumberTypeDto, OriginDto, PriceRoundingModeDto, PriceTypeDto };
+export { ProjectDto, ServiceSpecificationDto, IElementDto, PositionDto, ExecutionDescriptionDto, NoteTextDto, ServiceSpecificationGroupDto, ItemNumberDto, SelectedElement, ModeViewType, TableColumnType, IFunctionViewLine, IViewLine, ContextMenuDataType, ExchangePhaseDto, ItemNumberSchemaTierTypeDto, ItemNumberTypeDto, OriginDto, PriceRoundingModeDto, PriceTypeDto, ITextWordInvoice };

package/lib/ava-tree/tree/model/invoice-models.d.ts

@@ -0,0 +1,389 @@
+/** Type of the invoice */
+export declare enum InvoiceType {
+    PartialInvoice = 326,
+    CommercialInvoice = 380,
+    CreditNote = 381,
+    CorrectedInvoice = 384,
+    SelfBilledInvoice = 389,
+    PartialConstructionInvoice = 875,
+    PartialFinalConstructionInvoice = 876,
+    FinalConstructionInvoice = 877
+}
+/** This class holds typical references used in an invoice */
+export interface References {
+    /** An internal reference used by the buyer */
+    buyerReference?: string | undefined;
+    /** Reference to a project */
+    projectReference?: string | undefined;
+    /** Reference to a contract */
+    contractReference?: string | undefined;
+    /** Reference to a purchase order created by the buyer */
+    purchaseOrderReference?: string | undefined;
+    /** Reference to a sales order created by the seller */
+    salesOrderReference?: string | undefined;
+    /** Reference to a delivery note */
+    receivingAdviceReference?: string | undefined;
+    /** Reference to a dispatch advice */
+    dispatchAdviceReference?: string | undefined;
+    /** Reference to a tender or lot */
+    tenderOrLotReference?: string | undefined;
+    /** Reference to a custom item, e.g. a phone number, person,
+  contract or anything that would identify the invoice in the buyer's system */
+    invoicedObjectIdentifier?: string | undefined;
+}
+/** References to previous invoices */
+export interface PreviousInvoice {
+    /** The date of the previous invoice */
+    invoiceDate?: Date | undefined;
+    /** The number of the previous invoice */
+    invoiceNumber?: string | undefined;
+}
+/** Represents an organization, e.g. a buyer or a seller */
+export interface Organization {
+    /** The name of the organization */
+    name?: string | undefined;
+    /** The VAT ID for the organization */
+    vatId?: string | undefined;
+    /** An email address for the organization */
+    email?: string | undefined;
+    /** The name of a contact person */
+    contactPersonName?: string | undefined;
+    /** The phone of a contact person */
+    contactPersonPhone?: string | undefined;
+    /** The email of a contact person */
+    contactPersonEmail?: string | undefined;
+    /** The address of the organization */
+    address?: string | undefined;
+    /** The city of the organization */
+    city?: string | undefined;
+    /** The zip code of the organization */
+    zipCode?: string | undefined;
+    /** The ISO 3166-1 2 letter country code */
+    countryCode?: string | undefined;
+    /** The state of the organization, e.g. a federal state in Germany */
+    state?: string | undefined;
+}
+/** Represents a payee, meaning someone that receives the payment */
+export interface Payee {
+    /** The name of the payee */
+    name?: string | undefined;
+    /** The identifier of the payee */
+    identifier?: string | undefined;
+    /** A registered identifier for the payee, e.g. a VAT ID
+  or Tax ID */
+    legalRegistrationIdentifier?: string | undefined;
+}
+/** Represents a note / text in an invoice */
+export interface InvoiceNote {
+    /** Short summary / heading */
+    shortText?: string | undefined;
+    /** Explanation of this note */
+    longText?: string | undefined;
+}
+/** Represents an invoice period with start and end dates */
+export interface InvoicePeriod {
+    /** The start date */
+    start?: Date | undefined;
+    /** The end date */
+    end?: Date | undefined;
+}
+/** Totals for the invoice */
+export interface InvoiceTotals {
+    /** Sum of all invoice items in net. */
+    totalNet?: number | undefined;
+    /** This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice */
+    totalAllowances?: number | undefined;
+    /** This is the sum of all charges in the invoice, except VAT. For example, late
+  fees or surcharges. */
+    totalCharges?: number | undefined;
+    /** This is the total net value of the invoice after applied allowances and charges,
+  meaning the actual net sum to be paid. */
+    totalAfterDeductions?: number | undefined;
+    /** The total amount of VAT in the invoice. */
+    totalVatAmount?: number | undefined;
+    /** The total gross amount of the invoice, including all taxes and deductions. */
+    totalGross?: number | undefined;
+    /** The total amount that has already been paid for this invoice, e.g. used when
+  previous invoice sums are included here that have already been paid. */
+    alreadyPaidTotal?: number | undefined;
+    /** The sum that needs to be paid for this invoice. This is the total gross amount
+  minus the already paid amount. */
+    totalToBePaid?: number | undefined;
+}
+/** Instructions how payment for an invoice should be provided. */
+export interface PaymentInstructions {
+    /** Additional text to describe the payment instructions. */
+    description?: string | undefined;
+    /** This should be a code according to UN/ECE 4461
+  to identify the type of payment. For example, code "58" means SEPA Credit Transfer,
+  and code "30" means non-SEPA Credit Transfer. */
+    paymentTypeCode?: string | undefined;
+    /** A list of payment means that can be used to pay the invoice. */
+    paymentMeans?: PaymentMeans[] | undefined;
+}
+/** Represents a payment means for an invoice */
+export interface PaymentMeans {
+    /** This is typically the IBAN or account number */
+    accountIdentifier?: string | undefined;
+    /** The name for the account, typically the name of the owner for
+  a bank account. */
+    accountName?: string | undefined;
+    /** This can be the BIC */
+    serviceProviderIdentifier?: string | undefined;
+}
+/** Represents a document / attachment that is included with the invoice */
+export interface SupportingDocument {
+    /** This is typically an id or a name */
+    documentReference?: string | undefined;
+    /** A description of the document */
+    description?: string | undefined;
+    /** A link to the document in case this is an external reference */
+    externalDocumentUrl?: string | undefined;
+    /** The document in base64 encoded form as binary data */
+    documentBase64?: string | undefined;
+    /** This should be present if DocumentBase64 is set. */
+    fileName?: string | undefined;
+    /** The type of the document */
+    documentMimeType?: AttachmentMimeType | undefined;
+}
+/** Describes a mimne type of a document */
+export declare enum AttachmentMimeType {
+    Unknown = 0,
+    Pdf = 1,
+    Png = 2,
+    Jpeg = 3,
+    Csv = 4,
+    Excel = 5,
+    OpenOfficeSpreadsheet = 6
+}
+/** Describes the VAT breakdown for an invoice in a single VAT category */
+export interface VatBreakdown {
+    /** The total net amount of this VAT category */
+    netTaxableAmount?: number | undefined;
+    /** The total VAT */
+    vatAmount?: number | undefined;
+    /** The category of the VAT */
+    vatCategory?: VatCategory | undefined;
+    /** The actual tax rate as a decimal value,
+  e.g. 19% would be 0.19 */
+    taxRate?: number | undefined;
+    /** If the VAT is exempt, there should be a description here.
+  For example, in reverse charge scenarios, this text
+  should contain a reference to "Reverse charge according to ...". */
+    vatExemtpionReasonText?: string | undefined;
+    /** A code from the VAT exemption reason code list(VATEX)“ */
+    vatExemtpionReasonCode?: string | undefined;
+}
+/** The category used in a VatBreakdown"/> */
+export declare enum VatCategory {
+    Unknown = 0,
+    StandardRate = 1,
+    ZeroRatedGoods = 2,
+    ExemptFromTax = 3,
+    VatReverseCharge = 4,
+    VatExemptReverseCharge = 5,
+    FreeExportItem = 6,
+    ServicesOutsideScopeOfTaxation = 7,
+    CanaryIslandsGeneralIndirectTax = 8,
+    TaxInCeutaAndMelilla = 9
+}
+/** This describes an allowance in an invoice, which is a deduction from the total amount */
+export interface InvoiceAllowance {
+    /** The net amount of the allowance */
+    netAmount?: number | undefined;
+    /** If this is a relative / percentage allowance, this should be set
+  and give the base amount that is being used for the calculation */
+    relativeAllowanceBaseAmount?: number | undefined;
+    /** If this is a relative / percentage allowance, this should be set
+  and be given in decimal representation, meaning 19% would be 0.19 */
+    relativeAllowancePercentage?: number | undefined;
+    /** The VAT category for the allowance */
+    vatCategory?: VatCategory | undefined;
+    /** The actual tax rate as a decimal value,
+  meaning 19% would be 0.19 */
+    vatRate?: number | undefined;
+    /** A description of the allowance. */
+    reason?: string | undefined;
+    /** A reason code for the allowance according to UNTDID 5189. */
+    reasonCode?: string | undefined;
+}
+/** This describes an charge in an invoice, which is a surcharge to the total amount */
+export interface InvoiceCharge {
+    /** The net amount of the charge */
+    netAmount?: number | undefined;
+    /** If this is a relative / percentage charge, this should be set
+  and give the base amount that is being used for the calculation */
+    relativeChargeBaseAmount?: number | undefined;
+    /** If this is a relative / percentage charge, this should be set
+  and be given in decimal representation, meaning 19% would be 0.19 */
+    relativeChargePercentage?: number | undefined;
+    /** The VAT category for the charge */
+    vatCategory?: VatCategory | undefined;
+    /** The actual tax rate as a decimal value,
+  meaning 19% would be 0.19 */
+    vatRate?: number | undefined;
+    /** A description of the charge. */
+    reason?: string | undefined;
+    /** A reason code for the charge according to UNTDID 7161. */
+    reasonCode?: string | undefined;
+}
+/** Represents a single invoice line item */
+export interface InvoiceLineItem {
+    /** An unique identifier for the line item */
+    identifier?: string | undefined;
+    /** An unstructured note to classify line items */
+    note?: string | undefined;
+    /** A seller-defined object identifier for this line item,
+  meaning an identifier for the actual line. This could be
+  a numbering sequence or a reference to a product. */
+    objectIdentifier?: string | undefined;
+    /** The actual invoiced quantity of the line item */
+    quantity?: number | undefined;
+    /** A code for the unit of the quantity. This should be a code as defined
+  in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in
+  International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers,
+  Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names) */
+    unitCode?: string | undefined;
+    /** The net amount for this line item */
+    netAmount?: number | undefined;
+    /** A reference to an item in the buyers purachase order */
+    purchaseOrderReference?: string | undefined;
+    /** Information about the invoice period for this line item. */
+    lineItemPeriod?: InvoicePeriod | undefined;
+    /** Allowances specific to this line item */
+    allowances?: LineItemAllowance[] | undefined;
+    /** charges specific to this line item */
+    charges?: LineItemCharge[] | undefined;
+    /** Price details for this line item. */
+    priceDetails?: LineItemPriceDetail | undefined;
+    /** VAT information for this line item */
+    vatInformation?: LineItemVatInformation[] | undefined;
+    /** Information about this line item */
+    itemInformation?: LineItemInformation | undefined;
+    /** Line items can be nested, in which case this property holds the sub items */
+    subItems?: InvoiceLineItem[] | undefined;
+}
+/** Allowance for a single line item */
+export interface LineItemAllowance {
+    /** The net amount of the allowance */
+    netAmount?: number | undefined;
+    /** If this is a relative / percentage allowance, this should be set
+  and give the base amount that is being used for the calculation */
+    relativeAllowanceBaseAmount?: number | undefined;
+    /** If this is a relative / percentage allowance, this should be set
+  and be given in decimal representation, meaning 19% would be 0.19 */
+    relativeAllowancePercentage?: number | undefined;
+    /** A description of the allowance. */
+    reason?: string | undefined;
+    /** A reason code for the allowance according to UNTDID 5189. */
+    reasonCode?: string | undefined;
+}
+/** Charge for a single line item */
+export interface LineItemCharge {
+    /** The net amount of the charge */
+    netAmount?: number | undefined;
+    /** If this is a relative / percentage charge, this should be set
+  and give the base amount that is being used for the calculation */
+    relativeChargeBaseAmount?: number | undefined;
+    /** If this is a relative / percentage charge, this should be set
+  and be given in decimal representation, meaning 19% would be 0.19 */
+    relativeChargePercentage?: number | undefined;
+    /** A description of the charge. */
+    reason?: string | undefined;
+    /** A reason code for the charge according to UNTDID 7161. */
+    reasonCode?: string | undefined;
+}
+/** Price details about a line item */
+export interface LineItemPriceDetail {
+    /** The net price of this line item */
+    netPrice?: number | undefined;
+    /** A discount for this line item, given in decimal representation,
+  so 19% would be 0.19 */
+    discount?: number | undefined;
+    /** The gross price of this line item, meaning the price without taxes
+  that will be invoiced */
+    grossPrice?: number | undefined;
+    /** The quantity for which this price is valid */
+    baseQuantity?: number | undefined;
+    /** A code representing the unit for the base quantity */
+    baseQuantityUnitCode?: string | undefined;
+}
+/** VAT information for a single line item */
+export interface LineItemVatInformation {
+    /** The VAT category for the charge */
+    vatCategory?: VatCategory | undefined;
+    /** The actual tax rate as a decimal value,
+  meaning 19% would be 0.19 */
+    vatRate?: number | undefined;
+}
+/** Information about a single line item */
+export interface LineItemInformation {
+    /** A name for the line item */
+    name?: string | undefined;
+    /** A description for the line item */
+    description?: string | undefined;
+    /** An identifier assigned by the seller, e.g. an internal article number */
+    sellerIdentifier?: string | undefined;
+    /** An identifier assigned by the buyer, e.g. an internal article number */
+    buyerIdentifier?: string | undefined;
+    /** A standard identifier for the line item, e.g. an EAN or a GTIN */
+    standardIdentifier?: string | undefined;
+    /** A list of classification identifiers for the line item */
+    classificationIdentifiers?: string[] | undefined;
+    /** The origin country code according to ISO 3166-1 in 2 letter format */
+    countryOfOrigin?: string | undefined;
+    /** Optional additional attributes for this line item */
+    attributes?: LineItemAttribute[] | undefined;
+}
+/** A key-value pair for additional information */
+export interface LineItemAttribute {
+    /** The key / name of the attribute */
+    name?: string | undefined;
+    /** The value of the attribute */
+    value?: string | undefined;
+}
+/** This class represents an invoice */
+export interface Invoice {
+    /** The number of the invoice */
+    invoiceNumber?: string | undefined;
+    /** The date of the invoice */
+    invoiceDate?: Date | undefined;
+    /** The type of the invoice */
+    invoiceType?: InvoiceType | undefined;
+    /** The three letter ISO currency code */
+    currencyCode?: string | undefined;
+    /** Until when the payment is due */
+    paymentDueDate?: Date | undefined;
+    /** An object holding reference used in this invoice */
+    references?: References | undefined;
+    /** A text description of payment terms, e.g. cash discounts or payment conditions */
+    paymentTerms?: string | undefined;
+    /** In case of partial of final invoices, it's possible to reference the previous invoice numbers */
+    previousInvoices?: PreviousInvoice[] | undefined;
+    /** Information about the buyer */
+    buyer?: Organization | undefined;
+    /** Information about the seller */
+    seller?: Organization | undefined;
+    /** A payee is someone who receives the payment that is different from the seller */
+    payee?: Payee | undefined;
+    /** If present, this is an unstructured text that can be used to give additional information
+  about the invoice. */
+    invoiceNotes?: InvoiceNote[] | undefined;
+    /** The period during which the services or goods were delivered */
+    invoicePeriod?: InvoicePeriod | undefined;
+    /** Totals for the invoice */
+    totals?: InvoiceTotals | undefined;
+    /** Instructions how to perform the payment */
+    paymentInstructions?: PaymentInstructions | undefined;
+    /** Attached documents to the invoice */
+    documents?: SupportingDocument[] | undefined;
+    /** This is used to list VAT by category, e.g. for invoices
+  where parts are in different VAT categories */
+    vatBreakdown?: VatBreakdown[] | undefined;
+    /** Allowances / deductions on the invoice */
+    allowances?: InvoiceAllowance[] | undefined;
+    /** Charges / additional costs on the invoice */
+    charges?: InvoiceCharge[] | undefined;
+    /** Single line items in the invoice */
+    lineItems?: InvoiceLineItem[] | undefined;
+}

package/lib/ava-tree/tree/model/invoice-words.model.d.ts

@@ -0,0 +1,38 @@
+export interface ITextWordInvoice {
+    invoiceTitle?: string;
+    vatId?: string;
+    detailsInvoiceNumber?: string;
+    detailsInvoiceDate?: string;
+    detailsPaymentDueDate?: string;
+    detailsCurrencyCode?: string;
+    detailsPaymentTerms?: string;
+    referencesTopic?: string;
+    referencesBuyerReference?: string;
+    referencesProjectReference?: string;
+    referencesContractReference?: string;
+    referencesPurchaseOrderReference?: string;
+    referencesSalesOrderReference?: string;
+    referencesReceivingAdviceReference?: string;
+    referencesDispatchAdviceReference?: string;
+    referencesTenderOrLotReference?: string;
+    referencesInvoicedObjectIdentifier?: string;
+    tableHeadDescription?: string;
+    tableHeadQuantity?: string;
+    tableHeadUnit?: string;
+    tableHeadNetPrice?: string;
+    tableHeadNetAmount?: string;
+    totalsTopic?: string;
+    totalsTotalNet?: string;
+    totalsTotalAllowances?: string;
+    totalsTotalCharges?: string;
+    totalsTotalAfterDeductions?: string;
+    totalsTotalVatAmount?: string;
+    totalsTotalGross?: string;
+    totalsAlreadyPaidTotal?: string;
+    totalsTotalToBePaid?: string;
+    instructionsTopic?: string;
+    instructionsAccountIdentifier?: string;
+    instructionsAccountName?: string;
+    instructionsServiceProviderIdentifier?: string;
+    notesTopic?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dangl/angular-ava",
-  "version": "1.0.1-beta0011",
+  "version": "1.0.1-beta0021",
   "keywords": [
     "angular",
     "ava",

package/public-api.d.ts

@@ -2,3 +2,5 @@ export * from './lib/ava-tree/tree/model';
 export * from './lib/angular-ava.module';
 export * from './lib/version';
 export * from './lib/ava-tree/tree/components/ava-tree/ava-tree.component';
+export * from './lib/ava-tree/tree/constants';
+export { InvoiceDisplayComponent } from './lib/ava-tree/invoice/invoice-display/invoice-display.component';