@opencxh/domain 1.293.0 → 1.295.0

package/dist/entities/purchase/types.d.ts

@@ -0,0 +1,147 @@
+import { ProvisioningAction, ProvisioningState } from '../../platform/provisioning';
+import { Cents } from '../money/money';
+import { PricePer } from '../money/period-price';
+import { PostalAddress } from '../organization/types';
+import { Transaction, TransactionLine } from '../transaction/types';
+/**
+ * What a supplier asks for a product: one row per supplier and product (and validity window).
+ * The default offer is the product's cost price; the rest are the alternatives a buyer compares.
+ */
+export interface SupplierOffer {
+    id: string;
+    organizationId: string;
+    businessEntityId?: string;
+    supplierCompanyId: string;
+    productId: string;
+    /** Their article number. */
+    vendorSku?: string;
+    /**
+     * `unit`: a price per purchase unit. `rated`: per record on their rate card (telecom transit) —
+     * refused until that part exists, so nobody stores a price that means nothing yet.
+     */
+    pricing: "unit" | "rated";
+    /** Per purchase unit, for `per` (€ 222 per year) or once. */
+    costCents: Cents;
+    currency: string;
+    per?: PricePer;
+    /** The supplier's term: an NCE yearly licence is `year` even when billed monthly. */
+    term?: "month" | "year" | "3year";
+    /** How often they invoice; `costCents` is per `per`, not per invoice. */
+    billedEvery?: "month" | "year" | "once";
+    /** What you order in: a roll, a pallet, a box of 50. Absent = the product's own unit. */
+    purchaseUnit?: string;
+    /** Product units in one purchase unit: a roll of 500 m is 500. */
+    unitsPerPurchaseUnit?: number;
+    validFrom?: number;
+    validTo?: number;
+    minQty?: number;
+    leadDays?: number;
+    /** Days from each term's start the supplier still takes a change (NCE: 7). */
+    changeWindowDays?: number;
+    /** Ordered through an app instead of by mail (fase 9). */
+    provider?: {
+        app: string;
+        offer: string;
+    };
+    /**
+     * Where it lands when that is not the supplier (fase 9b): a Telnyx number on the customer's
+     * Eylo account. The platform's own offer takes it in, after the purchase.
+     */
+    deliverTo?: {
+        app: string;
+        offer: string;
+    };
+    isDefault: boolean;
+    createdBy: string;
+    createdAt?: number;
+    updatedAt?: number;
+}
+/** Ours to keep, or sold on to a customer — decides where the cost books (fase 6). */
+export type PurchaseUse = "own" | "resale";
+export interface PurchaseLine extends TransactionLine {
+    offerId?: string;
+    /** Sum of the booked receipts, in purchase units; recomputed, never added to. */
+    receivedQty: number;
+    /** Matched to supplier invoices (fase 7). */
+    billedQty: number;
+    use: PurchaseUse;
+    dimensions?: {
+        costCenterId?: string;
+        projectId?: string;
+    };
+    /** Absent = `purchase`. A change or an end points at the contract line it is about. */
+    action?: ProvisioningAction;
+    contractLine?: {
+        contractId: string;
+        lineId: string;
+    };
+    /** A change: the count it should be after. */
+    targetQuantity?: number;
+    /** When a change or end takes effect (epoch ms): the end of the term, not today. */
+    effectiveAt?: number;
+    /** Where this line came from in "Te bestellen", so it is not proposed twice. */
+    demandKey?: string;
+    /** The line of this order it waits for (the customer's account before its numbers). */
+    waitsFor?: string;
+    /** The supplier's ordering fields (a domain, a region). */
+    params?: Record<string, string>;
+    provisioning?: LineProvisioning;
+    /** The second step when the offer lands elsewhere (`deliverTo`): after a buy, before an end. */
+    delivery?: LineProvisioning;
+}
+/**
+ * A line's request at the supplier. `waiting`: its account is not there yet. `manual`: no API —
+ * a person does it and fills in the result.
+ */
+export interface LineProvisioning {
+    state: ProvisioningState | "waiting" | "manual";
+    requestId: string;
+    app?: string;
+    externalRef?: string;
+    fulfillment?: Record<string, string>;
+    missing?: {
+        key: string;
+        reason: string;
+    }[];
+    error?: string;
+    attempts?: number;
+    nextAttemptAt?: number;
+    updatedAt?: number;
+}
+export interface DeliverTo {
+    kind: "own" | "customer" | "site";
+    companyId?: string;
+    address?: PostalAddress;
+}
+/** A purchase order: a `Transaction` of kind `purchase_order`; `companyId` is the supplier. */
+export interface PurchaseOrder extends Omit<Transaction, "lines"> {
+    lines: PurchaseLine[];
+    deliverTo: DeliverTo;
+    /** Bought for this customer (the M365 seats for Acme). */
+    customerCompanyId?: string;
+}
+export interface GoodsReceiptLine {
+    poLineId: string;
+    /** Purchase units; positive, the movement says the direction. */
+    quantity: number;
+    serials: string[];
+    /** Still to come, as the packing slip says. */
+    backorderQty?: number;
+}
+/** Goods in (or back out). Booked is final: a mistake is corrected with a return. */
+export interface GoodsReceipt {
+    id: string;
+    organizationId: string;
+    businessEntityId?: string;
+    movement: "in" | "return";
+    purchaseOrderId: string;
+    supplierCompanyId: string;
+    receivedAt: number;
+    receivedBy: string;
+    source: "manual" | "upload" | "mail";
+    fileId?: string;
+    supplierRef?: string;
+    status: "draft" | "booked";
+    lines: GoodsReceiptLine[];
+    createdAt?: number;
+}

package/dist/entities/reports/reports.d.ts

@@ -29,6 +29,15 @@ export interface BooksReport {
     /** Where the figures come from: our books, or a connected package by name. */
     source: string;
 }
+/** A report row with its amount in this period and in the one it is compared to. */
+export interface ComparedRow extends BooksReportRow {
+    priorCents: Cents;
+}
+/**
+ * Two reports of the same kind side by side. A row only one of them has (an account that moved
+ * last year and not this year) keeps its place under its own parent, with 0 on the other side.
+ */
+export declare function compareReports(current: BooksReport, prior: BooksReport | null): ComparedRow[];
 /** A posted line as the reports need it: account, day, signed amount (debit +). */
 export interface ReportLine {
     accountId: string;

package/dist/entities/transaction/document.d.ts

@@ -1,6 +1,7 @@
 import { DocumentBlock } from '../../platform/document-blocks';
 import { DocumentSlots, TemplateContext } from '../document-template/tokens';
 import { TemplateCondition } from '../document-template/types';
+import { PricePer } from '../money/period-price';
 import { TaxRate } from '../money/tax';
 import { PostalAddress } from '../organization/types';
 import { Transaction } from './types';
@@ -56,6 +57,8 @@ export interface SlotLabels {
     optional: string;
     quantity: string;
     unitPrice: string;
+    /** After a period price: "222,00 per jaar". */
+    per: Record<PricePer, string>;
     net: string;
     tax: string;
     gross: string;

package/dist/entities/transaction/keys.d.ts

@@ -7,19 +7,13 @@
  * `invoice:412` even if invoices ever move to a finance app; one branded `sales_document:412`
  * would mean a backfill across four apps.
  */
-export declare const TRANSACTION_SCOPE_KINDS: readonly string[];
+export declare const SALES_SCOPE_KINDS: readonly string[];
 export declare const PRODUCT_SCOPE_KIND = "product";
 /** An agreement: what a customer takes every period. Puts it in the customer file. */
 export declare const AGREEMENT_SCOPE_KIND = "agreement";
 /** `invoice:412`. The kind of a transaction *is* its kind key — no mapping table. */
 export declare function transactionScopeKey(kindKey: string, id: string): string;
 export declare function productScopeKey(id: string): string;
-/**
- * The shell path of a document, under the administration it belongs to.
- *
- * `fallbackEntityId` is for a row that predates administrations (`""` = the default one); without
- * either there is no screen to point at, and no link beats a dead one.
- */
 export declare function transactionHref(row: {
     id: string;
     kindKey: string;

package/dist/entities/transaction/kinds.d.ts

@@ -53,6 +53,13 @@ export interface TransactionKind {
      */
     credits?: string;
 }
+/** What `apps/sales` issues. Another app's kinds live in their own list, same shape. */
+export declare const SALES_KINDS: readonly TransactionKind[];
+/**
+ * Every app's kinds, for looking one up by key. Keys are unique across apps (`invoice` is sales',
+ * `purchase_order` will be purchase's), so a key alone names its kind. Never enumerate this in an
+ * app: sales lists {@link SALES_KINDS}, or a purchase kind claims sales scopes and series.
+ */
 export declare const TRANSACTION_KINDS: readonly TransactionKind[];
 /**
  * Which kinds the app actually offers today.

package/dist/entities/transaction/types.d.ts

@@ -3,6 +3,7 @@ import { DocumentBlock } from '../../platform/document-blocks';
 import { LineUsage } from '../agreement/types';
 import { DocumentSender } from '../document-template/types';
 import { Cents } from '../money/money';
+import { PricePer } from '../money/period-price';
 import { TaxRateKind } from '../money/tax';
 import { OwnerScope } from '../scope/types';
 import { TransactionPaymentTerm } from './payment-term';
@@ -47,6 +48,11 @@ export interface Transaction {
     title?: string;
     reference?: string;
     currency: string;
+    /**
+     * Euro per unit of `currency`, set when issued in a currency the administration does not keep
+     * its books in (the ECB rate of that day). Absent in the books' own currency.
+     */
+    fxRate?: string;
     status: TransactionStatus;
     /**
      * The lines, as a column and not a table.
@@ -154,7 +160,9 @@ export interface Transaction {
  * A union and not a free string: kinds and their statuses are **ours**, not the organisation's.
  * Labels follow from the key as `status_<key>`.
  */
-export type TransactionStatus = "draft" | "sent" | "accepted" | "rejected" | "expired" | "confirmed" | "delivered" | "open" | "cancelled"
+export type TransactionStatus = "draft" | "sent" | "accepted" | "rejected" | "expired" | "confirmed" | "delivered"
+/** A purchase order whose every line came in. */
+ | "received" | "open" | "cancelled"
 /** A newer version of this document went out. Set by the server, never by a person. */
  | "superseded";
 export interface IssuedPaper {
@@ -175,6 +183,8 @@ export interface TransactionLine {
     unitKey: string;
     quantity: number;
     unitPriceCents: Cents;
+    /** The period the unit price is for ("€ 25 per month"). Absent = once, per unit. */
+    pricePer?: PricePer;
     discountPercent?: number;
     taxRateKey: string;
     /** Which rung of the price ladder produced this amount. Purely to account for it. */

package/dist/entities/work/index.d.ts

@@ -3,6 +3,6 @@ export * from './attention';
 export * from './item-types';
 export * from './keys';
 export * from './ladder';
+export * from './recurrence';
 export * from './types';
 export * from './view';
-export * from './recurrence';

package/dist/entities/work/types.d.ts

@@ -1,6 +1,6 @@
-import { WorkRecurrence } from './recurrence';
 import { Relation } from '../../platform/resource-source';
 import { OwnerScope } from '../scope/types';
+import { WorkRecurrence } from './recurrence';
 /**
  * Work management — one entity for everything that is *work*.
  *