@design.estate/dees-document 3.3.0 → 3.4.0

package/ts_web/elements/contentinvoice.ts

@@ -452,6 +452,21 @@ export class DeContentInvoice extends DeesElement {
         font-weight: bold;
       }
 
+      /* the tax an advance payment contains is stated, not added up */
+      .sums .sumline--contained .label,
+      .sums .sumline--contained .value {
+        font-weight: normal;
+        font-size: 11px;
+      }
+
+      .advancePayment {
+        margin-top: 2px;
+        padding-left: 20%;
+        font-size: 11px;
+        text-align: right;
+        color: #555;
+      }
+
       .divider {
         margin-top: 8px;
         border-top: 1px dotted #ccc;
@@ -747,20 +762,28 @@ export class DeContentInvoice extends DeesElement {
 
   /**
    * The due date, which only an accounting document and a payment reminder
-   * have: it counts `dueInDays` from the letter's date.
+   * have: it counts `dueInDays` from the letter's date. A document that
+   * states a paid amount names the amount due, since the total is not what
+   * remains to be paid.
    */
   private renderPaymentTerms(optionsArg: {
     date: number;
     dueInDays: number;
     labelKey: plugins.shared.translation.TranslationKey;
     textKey: plugins.shared.translation.TranslationKey;
+    /** the amount due, when the document states a paid amount */
+    amountDue?: number;
   }): TemplateResult {
     return html`<div class="infoBox">
       <div>
         <div>
           <div class="label">${this.translateKey(optionsArg.labelKey)}</div>
           <span>
-            ${this.translateKey(optionsArg.textKey)}
+            ${optionsArg.amountDue === undefined
+              ? this.translateKey(optionsArg.textKey)
+              : html`${this.translateKey("payment.amountDue")}:
+                ${this.formatPrice(optionsArg.amountDue)}
+                ${this.translateKey("payment.terms.amountDue")}`}
             ${this.formatDay(
               new Date(optionsArg.date).setDate(
                 new Date(optionsArg.date).getDate() + optionsArg.dueInDays
@@ -824,6 +847,115 @@ export class DeContentInvoice extends DeesElement {
     </div>`;
   }
 
+  /**
+   * The paid amount and the amount due, below the gross total, when the
+   * document states a paid amount (EN 16931 BT-113 and BT-115). The advance
+   * payments a final invoice deducts are deducted as the gross total received,
+   * with the tax it contains stated per rate, as Abschnitt 14.8 Abs. 7 Satz 3
+   * UStAE allows: "Statt der vorausgezahlten Entgelte oder Teilentgelte und
+   * der Steuerbeträge können auch die Gesamtbeträge der Voraus- oder
+   * Anzahlungen abgesetzt und die darin enthaltenen Steuerbeträge zusätzlich
+   * angegeben werden." More paid than the total prints as a credit balance.
+   */
+  private renderPaidAmountSums(
+    summaryArg: plugins.shared.IPaidAmountSummary
+  ): TemplateResult {
+    return html`<div class="sumline">
+        <div class="label">${this.translateKey("payment.paid")}</div>
+        <div class="value rightAlign amountCell">
+          ${this.formatPrice(summaryArg.paidAmount)}
+        </div>
+      </div>
+      ${summaryArg.advancePaymentTaxes.map(
+        (taxArg) => html`<div class="sumline sumline--contained">
+          <div class="label">
+            ${this.translateKey("advancePayment.vat")} ${taxArg.percentage}%
+          </div>
+          <div class="value rightAlign amountCell">
+            ${this.formatPrice(taxArg.vat)}
+          </div>
+        </div>`
+      )}
+      <div class="sumline">
+        <div class="label">
+          ${this.translateKey(
+            summaryArg.amountDue < 0 ? "payment.creditBalance" : "payment.amountDue"
+          )}
+        </div>
+        <div class="value value--total rightAlign amountCell">
+          ${this.formatPrice(Math.abs(summaryArg.amountDue))}
+        </div>
+      </div>`;
+  }
+
+  /**
+   * The advance payments the paid amount deducts, one line each, by the
+   * advance invoice's number and date and the day the payment was received,
+   * as far as the document states them. Each line is its own block, so a long
+   * list flows across pages.
+   */
+  private renderAdvancePayments(
+    summaryArg: plugins.shared.IPaidAmountSummary
+  ): TemplateResult[] {
+    return summaryArg.advancePayments.map(
+      (paymentArg) => html`<div class="advancePayment">
+        ${this.translateKey("advancePayment.title")}${paymentArg.invoice
+          ? html` ${this.translateKey("advancePayment.invoice")}
+            ${paymentArg.invoice.documentId}${paymentArg.invoice.issueDate !== undefined
+              ? html` ${this.translateKey("advancePayment.invoiceDate")}
+                ${this.formatDay(paymentArg.invoice.issueDate)}`
+              : null}`
+          : null}${paymentArg.receivedOn !== undefined
+          ? html`, ${this.translateKey("advancePayment.received")}
+            ${this.formatDay(paymentArg.receivedOn)}`
+          : null}
+      </div>`
+    );
+  }
+
+  /**
+   * What the document asks to be paid: the payment terms and the QR pay box
+   * for the gross total, or for the amount due when the document states a
+   * paid amount. When nothing is due, it says so, and names the credit
+   * balance when more was paid than the total; there are no terms and no QR
+   * pay box then.
+   */
+  private renderPaymentRequest(
+    accountingDocArg: plugins.tsclass.finance.TAccountingDoc,
+    summaryArg: plugins.shared.IPaidAmountSummary | null
+  ): TemplateResult {
+    if (summaryArg && summaryArg.amountDue <= 0) {
+      return html`<div class="infoBox">
+        <div>
+          <div>
+            <div class="label">${this.translateKey("invoice@@payment.terms")}</div>
+            <span>
+              ${summaryArg.amountDue === 0
+                ? this.translateKey("payment.nothingDue")
+                : html`${this.translateKey("payment.nothingDue.creditBalance")}
+                  ${this.formatPrice(-summaryArg.amountDue)}.`}
+            </span>
+          </div>
+        </div>
+      </div>`;
+    }
+    return html`
+      ${this.renderPaymentTerms({
+        date: accountingDocArg.date,
+        dueInDays: accountingDocArg.dueInDays,
+        labelKey: "invoice@@payment.terms",
+        textKey: "invoice@@payment.terms.direct",
+        amountDue: summaryArg?.amountDue,
+      })}
+      ${this.renderPaymentInfo({
+        from: accountingDocArg.from,
+        currency: accountingDocArg.currency,
+        amount: summaryArg ? summaryArg.amountDue : this.getTotalGross(),
+        reference: accountingDocArg.id,
+      })}
+    `;
+  }
+
   /**
    * The reverse-charge statement. § 14a UStG requires the words
    * "Steuerschuldnerschaft des Leistungsempfängers": Abs. 5 for a domestic
@@ -1200,6 +1332,10 @@ export class DeContentInvoice extends DeesElement {
       return;
     }
     const accountingDoc = this.accountingDoc;
+    // throws when the advance payments do not add up to the paid amount
+    const paidAmountSummary = accountingDoc
+      ? plugins.shared.getPaidAmountSummary(accountingDoc, this.getTotalGross())
+      : null;
     render(
       html`
         ${this.renderCorrection()}
@@ -1296,7 +1432,9 @@ export class DeContentInvoice extends DeesElement {
               ${this.formatPrice(this.getTotalGross())}
             </div>
           </div>
+          ${paidAmountSummary ? this.renderPaidAmountSums(paidAmountSummary) : null}
         </div>
+        ${paidAmountSummary ? this.renderAdvancePayments(paidAmountSummary) : null}
         <div class="divider"></div>
 
         ${accountingDoc?.reverseCharge ? this.renderReverseChargeNote() : ``}
@@ -1307,24 +1445,9 @@ export class DeContentInvoice extends DeesElement {
         <!-- NOTES -->
         ${this.renderNotes(accountingDoc?.notes)}
 
-        <!-- PAYMENT TERMS -->
-        ${accountingDoc && this.docContent.requestsPayment
-          ? this.renderPaymentTerms({
-              date: accountingDoc.date,
-              dueInDays: accountingDoc.dueInDays,
-              labelKey: "invoice@@payment.terms",
-              textKey: "invoice@@payment.terms.direct",
-            })
-          : null}
-
-        <!-- PAYMENT INFO -->
+        <!-- PAYMENT TERMS AND PAYMENT INFO -->
         ${accountingDoc && this.docContent.requestsPayment
-          ? this.renderPaymentInfo({
-              from: accountingDoc.from,
-              currency: accountingDoc.currency,
-              amount: this.getTotalGross(),
-              reference: accountingDoc.id,
-            })
+          ? this.renderPaymentRequest(accountingDoc, paidAmountSummary)
           : null}
       `,
       contentNodes.currentContent

package/ts_web/elements/document.ts

@@ -151,6 +151,17 @@ export class DeDocument extends DeesElement {
   public paginationInfo: IPagePaginationInfo[] = [];
 
   public async renderDocument() {
+    // a document whose advance payments do not add up to its paid amount is
+    // refused: no page of it, and none of the letter before it, stays on screen
+    try {
+      plugins.shared.assertPaidAmountMatchesAdvancePayments(this.letterData);
+    } catch (error) {
+      this.latestDocumentSettings = this.documentSettings;
+      this.latestRenderedLetterData = this.letterData;
+      this.paginationInfo = [];
+      this.shadowRoot?.querySelector(".documentContainer")?.replaceChildren();
+      throw error;
+    }
     this.latestDocumentSettings = this.documentSettings;
     this.latestRenderedLetterData = this.letterData;
     this.paginationInfo = [];