Bundle-JSON

Die Karte Zusätzliche Rechnungspositionen speichert ein Bundle als JSON am Produkt, unter dem Schlüssel invoiceBundle. Für Importe verwenden Sie dieselbe Struktur. Für den normalen Gebrauch brauchen Sie diese Seite nicht: Die Felder und ihre Erklärung finden Sie unter Bundle-Schritte.

StrukturLink zu diesem Abschnitt kopieren

Jeder Schritt ist ein Produktschritt oder ein Infozeilenschritt.

ProduktschrittLink zu diesem Abschnitt kopieren

InfozeilenschrittLink zu diesem Abschnitt kopieren

{
  "stepKind": "info",
  "description": "Inclusief toeristen-, gemeente- en provincietaksen"
}

description ist Pflicht, und ein Infozeilenschritt hat keine productId. Mit style (DEFAULT oder INFO) wählen Sie den Zeilenstil, standardmäßig ist das INFO. Eine formula, die false zurückgibt, lässt die Infozeile weg.

FormelLink zu diesem Abschnitt kopieren

formula ist TypeScript, das beim Speichern einer Rechnung true (eine Position mit quantity), false (keine Position), eine Zahl (die Menge) oder eine Liste von Positionen { "quantity", "description", "unitPrice", "accessMethodValue" } zurückgibt. Welche Felder und Listen Sie lesen können und was jede Form bewirkt, steht unter Formel pro Schritt. Eine Formel, die nicht kompiliert, wird beim Speichern des Produkts abgelehnt. In JSON steht die Formel als ein String mit \n für Zeilenumbrüche.

"formula": "return {customer.customFields.exemptFromSurcharges} !== true;"

NFC-VerlängerungLink zu diesem Abschnitt kopieren

Nur sinnvoll, wenn das Hauptprodukt Belegung verlängern als Aktion hat.

"extendAccessMethod": { "daysAfterPeriodEnd": 20 }

Wird eine Position eines solchen Schritts bezahlt, setzt Tillor die Gültigkeit der Zugangsmethoden des Kunden auf das Enddatum der Hauptposition plus daysAfterPeriodEnd Kalendertage. Standardmäßig läuft sie bis 23:59 Uhr in der Zeitzone der Organisation, oder bis zum Wochentag und zur Uhrzeit von Zugangsmethode verlängern am Hauptprodukt. Welche Typen und Status berücksichtigt werden, stellen Sie dort ebenfalls ein. Ohne Enddatum an der Hauptposition passiert nichts. Ist Bei Verlängerung nicht verkürzen eingeschaltet, überspringt Tillor Methoden, deren Gültigkeit bereits am oder nach dem neuen Datum liegt. Ein accessMethodValue an der Position benennt die Methode dieser Position; die Verlängerung selbst folgt den Einstellungen des Hauptprodukts.

Nach einer erfolgreichen Verlängerung steht in der Zeitleiste der Rechnung eine Zeile, die auf die Zahlung verweist.

Beispiel: Hinweis, NFC-Zuschlag, Zählermiete und HundeLink zu diesem Abschnitt kopieren

{
  "invoiceBundle": {
    "version": 1,
    "steps": [
      {
        "stepKind": "info",
        "description": "Inclusief toeristen-, gemeente- en provincietaksen"
      },
      {
        "productId": "prd_nfc_toeslag",
        "quantity": 1,
        "quantityScale": "anchor_line_quantity",
        "extendAccessMethod": { "daysAfterPeriodEnd": 20 },
        "style": "INFO",
        "billOncePerInvoice": true,
        "formula": "const nfc = {accessMethods}.filter((a) => a.type === \"NFC\" && a.status === \"ACTIVE\");\nreturn nfc.slice(0, 1).map((a) => ({ quantity: 0, unitPrice: 0, accessMethodValue: a.value, description: `Toegangsmethode inclusief: ${a.label}` }));"
      },
      {
        "productId": "prd_nfc_toeslag",
        "quantity": 1,
        "quantityScale": "anchor_line_quantity",
        "extendAccessMethod": { "daysAfterPeriodEnd": 20 },
        "billOncePerInvoice": true,
        "formula": "const nfc = {accessMethods}.filter((a) => a.type === \"NFC\" && a.status === \"ACTIVE\");\nreturn nfc.slice(1).map((a) => ({ quantity: 1, accessMethodValue: a.value, description: `Toeslag extra toegangsmethode: ${a.label}` }));"
      },
      {
        "productId": "prd_meterhuur",
        "quantity": 1,
        "quantityScale": "anchor_line_quantity",
        "formula": "return {meters}.filter((m) => m.provider === \"ICY\" && m.type === \"ELECTRICITY\" && m.icyMetadata?.switchState === true).map((m) => ({ quantity: 1, description: `Huur digitale elektriciteitsmeter ${m.name}` }));"
      },
      {
        "productId": "prd_hond",
        "quantity": 1,
        "quantityScale": "anchor_line_quantity",
        "billOncePerInvoice": true,
        "formula": "const dogs = Math.max(0, Math.floor(Number({customer.customFields.animals.dogs}) || 0));\nreturn dogs === 0 ? false : [{ quantity: dogs, description: `Honden (${dogs})` }];"
      }
    ]
  }
}

Siehe auchLink zu diesem Abschnitt kopieren