shutro-erp 0.3.6 → 0.3.7

package/dist/accounting/followups.d.ts

@@ -0,0 +1,618 @@
+/**
+ * Payment follow-ups (RFC 0029 §3.4). Levels say how late an invoice must be (days past its due date), how the
+ * customer is reminded (email, SMS, WhatsApp), with what text, and whether sales to them stop. Once a day — and on
+ * Send now — each customer's overdue invoices are found, the highest level reached and not sent yet is picked, and
+ * one reminder goes out with every overdue invoice and its portal link (when the portal is installed); it is noted
+ * on each invoice's chatter and logged. A customer is paused until a date (a promise to pay); once nothing is
+ * overdue, their follow-up starts over.
+ */
+import type { Mailer } from '../mail/index.js';
+import type { Messenger } from '../notify/index.js';
+import { type Env } from './.kosh/bindings.js';
+/** A follow-up level: how late, how the customer is reminded, whether sales stop. */
+export declare const AccountFollowupLevel: import("../server/orm.js").Model<"account.followup.level", {
+    readonly id: import("../server/orm.js").IdField<"account.followup.level">;
+    readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly createdBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly displayName: import("../server/orm.js").CharField<{
+        required: true;
+        readonly: true;
+        computed: true;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly active: import("../server/orm.js").ActiveField;
+    readonly company: import("../server/orm.js").CompanyField<true>;
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string | Readonly<Record<string, string>>>;
+    readonly days: import("../server/orm.js").ScalarField<"integer", number, number, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly sendEmail: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly sendSms: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly sendWhatsapp: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly subject: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string | Readonly<Record<string, string>>>;
+    readonly body: import("../server/orm.js").ScalarField<"text", string, string | Readonly<Record<string, string>>, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly shortText: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string | Readonly<Record<string, string>>>;
+    readonly blockSales: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+}, {} & import("../server/orm.js").TransitionMethods<{
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string | Readonly<Record<string, string>>>;
+    readonly days: import("../server/orm.js").ScalarField<"integer", number, number, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly sendEmail: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly sendSms: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly sendWhatsapp: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly subject: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string | Readonly<Record<string, string>>>;
+    readonly body: import("../server/orm.js").ScalarField<"text", string, string | Readonly<Record<string, string>>, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly shortText: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string | Readonly<Record<string, string>>>;
+    readonly blockSales: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+}>>;
+/** Where a customer is in their follow-up, per company. */
+export declare const AccountFollowup: import("../server/orm.js").Model<"account.followup", {
+    readonly id: import("../server/orm.js").IdField<"account.followup">;
+    readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly createdBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly displayName: import("../server/orm.js").CharField<{
+        required: true;
+        readonly: true;
+        computed: true;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly company: import("../server/orm.js").CompanyField<true>;
+    readonly partner: import("../server/orm.js").Many2oneField<"res.partner", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly level: import("../server/orm.js").Many2oneField<"account.followup.level", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly sentAt: import("../server/orm.js").ScalarField<"datetime", Date, Date, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly pausedUntil: import("../server/orm.js").ScalarField<"date", string, string, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly pauseNote: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}, {} & import("../server/orm.js").TransitionMethods<{
+    readonly partner: import("../server/orm.js").Many2oneField<"res.partner", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly level: import("../server/orm.js").Many2oneField<"account.followup.level", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly sentAt: import("../server/orm.js").ScalarField<"datetime", Date, Date, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly pausedUntil: import("../server/orm.js").ScalarField<"date", string, string, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly pauseNote: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}>>;
+/** One reminder sent. */
+export declare const AccountFollowupSent: import("../server/orm.js").Model<"account.followup.sent", {
+    readonly id: import("../server/orm.js").IdField<"account.followup.sent">;
+    readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly createdBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly displayName: import("../server/orm.js").CharField<{
+        required: true;
+        readonly: true;
+        computed: true;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly company: import("../server/orm.js").CompanyField<true>;
+    readonly partner: import("../server/orm.js").Many2oneField<"res.partner", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly level: import("../server/orm.js").Many2oneField<"account.followup.level", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly amount: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+    readonly invoices: import("../server/orm.js").Many2manyField<"account.move", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly channels: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+    readonly automatic: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+}, {} & import("../server/orm.js").TransitionMethods<{
+    readonly partner: import("../server/orm.js").Many2oneField<"res.partner", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly level: import("../server/orm.js").Many2oneField<"account.followup.level", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly amount: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+    readonly invoices: import("../server/orm.js").Many2manyField<"account.move", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly channels: import("../server/orm.js").CharField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+    readonly automatic: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+}>>;
+/** Sets the mailer, the text messenger and the portal address (null: no links). */
+export declare function configureFollowups(next: {
+    mailer: Mailer | undefined;
+    messenger: Messenger | undefined;
+    portalUrl: string | null;
+}): void;
+type Money = {
+    amount: string;
+    currency: string;
+};
+/** A customer's overdue invoices, oldest first. */
+export interface Overdue {
+    readonly partner: number;
+    readonly name: string;
+    readonly email: string | null;
+    readonly phone: string | null;
+    readonly invoices: readonly {
+        readonly id: number;
+        readonly name: string;
+        readonly dateDue: string;
+        readonly days: number;
+        readonly residual: Money;
+    }[];
+    /** Days the oldest is late. */
+    readonly days: number;
+    /** What is overdue, by currency (`1,200.00 BDT + 50.00 USD`). */
+    readonly amount: string;
+}
+/** Customers with posted invoices past their due date in the environment's company, by partner. */
+export declare function overdueCustomers(env: Env, only?: number): Promise<Overdue[]>;
+/** One line per row of the follow-ups screen. */
+export interface FollowupRow extends Overdue {
+    readonly due: {
+        readonly id: number;
+        readonly name: string;
+    } | null;
+    readonly sent: {
+        readonly id: number;
+        readonly name: string;
+    } | null;
+    readonly sentAt: string | null;
+    readonly pausedUntil: string | null;
+    readonly pauseNote: string | null;
+}
+/** Who is late, the level they reached, the last one sent, and whether they are paused. */
+export declare function followupRows(env: Env): Promise<FollowupRow[]>;
+/**
+ * Sends a customer the reminder of the highest level they reached (`force`: even when it was sent, or they are
+ * paused — Send now). Returns the channels used, or null when nothing was due.
+ */
+export declare function followUp(env: Env, partner: number, options?: {
+    force?: boolean;
+    automatic?: boolean;
+}): Promise<{
+    level: string;
+    channels: string[];
+} | null>;
+/** Pauses a customer's reminders until a date (null: resumes them). */
+export declare function pauseFollowup(env: Env, partner: number, until: string | null, note: string | null): Promise<void>;
+/** The daily run for the environment's company (as the system): each late customer, once per level. */
+export declare function runFollowups(env: Env): Promise<number>;
+/** Whether sales to a customer are stopped by the level they are at (RFC 0028 credit control's companion). */
+export declare function salesStopped(env: Env, partner: number): Promise<{
+    level: string;
+} | null>;
+/** The levels a company starts with: a reminder at 15 days, a firmer one with a text at 30, sales stopped at 60. */
+export declare function installFollowupLevels(env: Env): Promise<void>;
+export {};