shutro-erp 0.2.0 → 0.3.0

package/dist/l10n_in/documents.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The GST documents (RFC 0016 step 5), as document templates (RFC 0005): the tax invoice with what rule 46 of the
+ * CGST Rules asks for — supplier and recipient with their GSTIN, the place of supply, each line's HSN / SAC, taxable
+ * value, rate and CGST / SGST / IGST / cess, whether tax is payable under reverse charge, the total in words — and
+ * the credit and debit notes. The company's to change in the designer.
+ */
+import type { DocumentSpec } from '../modules-sdk/index.js';
+export declare const GST_DOCUMENTS: readonly DocumentSpec[];

package/dist/l10n_in/documents.js

@@ -0,0 +1,114 @@
+const parties = {
+    kind: 'columns',
+    id: 'parties',
+    left: [
+        {
+            kind: 'fields',
+            id: 'supplier',
+            items: [
+                { label: 'Supplier', bind: 'company.name' },
+                { label: 'GSTIN', bind: 'company.gstin' },
+                { label: 'State', bind: 'company.state' },
+            ],
+        },
+    ],
+    right: [
+        {
+            kind: 'fields',
+            id: 'recipient',
+            items: [
+                { label: 'Recipient', bind: 'partner.name' },
+                { label: 'GSTIN', bind: 'partner.gstin' },
+                { label: 'Address', bind: 'partner.street' },
+                { label: 'City', bind: 'partner.city' },
+                { label: 'State', bind: 'partner.state' },
+            ],
+        },
+    ],
+};
+const lines = {
+    kind: 'table',
+    id: 'lines',
+    bind: 'invoiceLines',
+    columns: [
+        { label: 'Description', bind: 'name' },
+        { label: 'HSN / SAC', bind: 'product.hsnCode' },
+        { label: 'Qty', bind: 'quantity', align: 'end' },
+        { label: 'Rate', bind: 'priceUnit', align: 'end' },
+        { label: 'Taxable value', bind: 'subtotal', align: 'end', sum: true },
+        { label: 'GST %', bind: 'gstRate', align: 'end' },
+        { label: 'CGST', bind: 'cgstAmount', align: 'end', sum: true },
+        { label: 'SGST', bind: 'sgstAmount', align: 'end', sum: true },
+        { label: 'IGST', bind: 'igstAmount', align: 'end', sum: true },
+        { label: 'Cess', bind: 'cessAmount', align: 'end', sum: true },
+        { label: 'Total', bind: 'totalWithGst', align: 'end', sum: true },
+    ],
+};
+const totals = {
+    kind: 'fields',
+    id: 'totals',
+    columns: 3,
+    items: [
+        { label: 'Taxable value', bind: 'amountUntaxed' },
+        { label: 'GST and cess', bind: 'amountTax' },
+        { label: 'Total', bind: 'amountTotal' },
+    ],
+};
+const signature = {
+    kind: 'signature',
+    id: 'signature',
+    labels: ['For the supplier: authorised signatory'],
+};
+const document = (key, name, title, extra) => ({
+    key,
+    name,
+    model: 'account.move',
+    layout: {
+        paper: 'A4',
+        orientation: 'landscape',
+        header: '{{company.name}} · GSTIN {{company.gstin}}',
+        footer: `${title} · Page {{page}} of {{pages}}`,
+        blocks: [
+            { kind: 'heading', id: 'title', text: title, level: 1 },
+            // Once registered with the IRP (e-invoicing): the IRN and its acknowledgement.
+            {
+                kind: 'fields',
+                id: 'irn',
+                columns: 3,
+                items: [
+                    { label: 'IRN', bind: 'irn' },
+                    { label: 'Ack. no.', bind: 'irnAckNo' },
+                    { label: 'Ack. date', bind: 'irnAckDate' },
+                ],
+            },
+            parties,
+            {
+                kind: 'fields',
+                id: 'document',
+                columns: 3,
+                items: [
+                    { label: 'Number', bind: 'name' },
+                    { label: 'Date', bind: 'date' },
+                    { label: 'Place of supply', bind: 'placeOfSupply' },
+                    { label: 'Tax payable on reverse charge', bind: 'gstReverseCharge' },
+                    ...extra,
+                ],
+            },
+            lines,
+            totals,
+            { kind: 'text', id: 'in_words', text: 'In words: {{amountTotal|words}}' },
+            signature,
+        ],
+    },
+});
+export const GST_DOCUMENTS = [
+    document('gst_tax_invoice', 'Tax invoice (GST)', 'Tax invoice', []),
+    document('gst_credit_note', 'Credit note (GST)', 'Credit note', [
+        { label: 'Against invoice', bind: 'reversalOf.name' },
+        { label: 'Reason', bind: 'ref' },
+    ]),
+    document('gst_debit_note', 'Debit note (GST)', 'Debit note', [
+        { label: 'Against invoice', bind: 'debitOf.name' },
+        { label: 'Reason', bind: 'ref' },
+    ]),
+];

package/dist/l10n_in/einvoice.d.ts

@@ -0,0 +1,253 @@
+import type { Env } from './.kosh/bindings.js';
+/** An item of the IRP payload. */
+export interface EInvoiceItem {
+    readonly SlNo: string;
+    readonly PrdDesc: string;
+    readonly IsServc: 'Y' | 'N';
+    readonly HsnCd: string;
+    readonly Qty: number;
+    readonly Unit: string;
+    readonly UnitPrice: number;
+    readonly TotAmt: number;
+    readonly Discount: number;
+    readonly AssAmt: number;
+    readonly GstRt: number;
+    readonly IgstAmt: number;
+    readonly CgstAmt: number;
+    readonly SgstAmt: number;
+    readonly CesAmt: number;
+    readonly TotItemVal: number;
+}
+/** The IRP's e-invoice schema (version 1.1), as far as Kosh fills it. */
+export interface EInvoicePayload {
+    readonly Version: '1.1';
+    readonly TranDtls: {
+        readonly TaxSch: 'GST';
+        readonly SupTyp: 'B2B' | 'EXPWP' | 'EXPWOP';
+        readonly RegRev: 'Y' | 'N';
+        readonly IgstOnIntra: 'N';
+    };
+    readonly DocDtls: {
+        readonly Typ: 'INV' | 'CRN' | 'DBN';
+        readonly No: string;
+        readonly Dt: string;
+    };
+    readonly SellerDtls: {
+        readonly Gstin: string;
+        readonly LglNm: string;
+        readonly Addr1: string;
+        readonly Loc: string;
+        readonly Pin: number;
+        readonly Stcd: string;
+    };
+    readonly BuyerDtls: {
+        readonly Gstin: string;
+        readonly LglNm: string;
+        readonly Pos: string;
+        readonly Addr1: string;
+        readonly Loc: string;
+        readonly Pin: number;
+        readonly Stcd: string;
+    };
+    readonly ItemList: readonly EInvoiceItem[];
+    readonly ValDtls: {
+        readonly AssVal: number;
+        readonly CgstVal: number;
+        readonly SgstVal: number;
+        readonly IgstVal: number;
+        readonly CesVal: number;
+        readonly TotInvVal: number;
+    };
+}
+/** The e-way bill: part A from the invoice, part B the transport. */
+export interface EwayBillPayload {
+    readonly supplyType: 'O';
+    readonly docType: 'INV' | 'CHL';
+    readonly docNo: string;
+    readonly docDate: string;
+    readonly fromGstin: string;
+    readonly fromPincode: number;
+    readonly fromStateCode: number;
+    readonly toGstin: string;
+    readonly toPincode: number;
+    readonly toStateCode: number;
+    readonly totInvValue: number;
+    readonly transMode: '1' | '2' | '3' | '4';
+    readonly transDistance: number;
+    readonly transporterId: string;
+    readonly vehicleNo: string;
+    /** The IRN, when the invoice was e-invoiced. */
+    readonly irn?: string;
+}
+/** What a provider answers, or refuses with {@link GstProviderError}. */
+export interface GstProvider {
+    readonly name: string;
+    registerInvoice(payload: EInvoicePayload): Promise<{
+        irn: string;
+        ackNo: string;
+        ackDate: string;
+        signedQr: string;
+    }>;
+    cancelInvoice(seller: string, irn: string, reason: string, remark: string): Promise<{
+        cancelledAt: string;
+    }>;
+    generateEwayBill(payload: EwayBillPayload): Promise<{
+        ewbNo: string;
+        ewbDate: string;
+        validUntil: string;
+    }>;
+    cancelEwayBill(seller: string, ewbNo: string, reason: string, remark: string): Promise<{
+        cancelledAt: string;
+    }>;
+}
+/** A refusal of the IRP or the e-way bill system: its code and message, kept on the document. */
+export declare class GstProviderError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+/** The financial year (April–March) of `iso` as the IRN uses it: `2026-27`. */
+export declare function financialYear(iso: string): string;
+/** The IRN of a document: SHA-256 of the seller's GSTIN, the financial year, the document type and number. */
+export declare function irnOf(gstin: string, docType: string, docNo: string, iso: string): string;
+/** A provider answering like the IRP and the e-way bill system, in memory (tests, demonstrations). */
+export declare function createFakeGstProvider(now?: () => Date): GstProvider & {
+    readonly invoices: Map<string, {
+        cancelled: boolean;
+        ackDate: string;
+    }>;
+};
+/** The provider the environment names (`KOSH_GST_PROVIDER=fake`), or none: e-invoicing is then unavailable. */
+export declare function gstProviderFromEnv(env?: NodeJS.ProcessEnv): GstProvider | undefined;
+/** A document's payload for the IRP, or the reasons the IRP would refuse it. */
+export declare function einvoicePayload(env: Env, id: number): Promise<{
+    payload: EInvoicePayload | null;
+    problems: string[];
+    seller: string;
+}>;
+/** The state of a document's e-invoice and e-way bill (what the screen shows). */
+export declare function einvoiceState(env: Env, id: number): Promise<{
+    status: "cancelled" | "failed" | "registered" | null;
+    irn: string | null;
+    ackNo: string | null;
+    ackDate: Date | null;
+    signedQr: string | null;
+    cancelledAt: Date | null;
+    error: string | null;
+    ewayBill: {
+        status: "cancelled" | "failed" | "generated" | null;
+        number: string | null;
+        date: Date | null;
+        validUntil: Date | null;
+        vehicleNo: string | null;
+        transporterId: string | null;
+        distanceKm: number | null;
+        mode: "air" | "rail" | "road" | "ship" | null;
+        error: string | null;
+    };
+}>;
+/**
+ * Registers a document with the IRP. The document must be readable and the user may post (the right to e-invoice
+ * goes with it). A refusal, here or by the IRP, is kept on the document and answered with 422.
+ */
+export declare function registerEInvoice(env: Env, provider: GstProvider | undefined, id: number): Promise<{
+    status: "cancelled" | "failed" | "registered" | null;
+    irn: string | null;
+    ackNo: string | null;
+    ackDate: Date | null;
+    signedQr: string | null;
+    cancelledAt: Date | null;
+    error: string | null;
+    ewayBill: {
+        status: "cancelled" | "failed" | "generated" | null;
+        number: string | null;
+        date: Date | null;
+        validUntil: Date | null;
+        vehicleNo: string | null;
+        transporterId: string | null;
+        distanceKm: number | null;
+        mode: "air" | "rail" | "road" | "ship" | null;
+        error: string | null;
+    };
+}>;
+/** The IRP's reasons to cancel an IRN. */
+export declare const CANCEL_REASONS: Readonly<Record<string, string>>;
+/** Cancels a document's IRN, within 24 hours of its acknowledgement. The document itself is reversed separately. */
+export declare function cancelEInvoice(env: Env, provider: GstProvider | undefined, id: number, reason: string, remark: string): Promise<{
+    status: "cancelled" | "failed" | "registered" | null;
+    irn: string | null;
+    ackNo: string | null;
+    ackDate: Date | null;
+    signedQr: string | null;
+    cancelledAt: Date | null;
+    error: string | null;
+    ewayBill: {
+        status: "cancelled" | "failed" | "generated" | null;
+        number: string | null;
+        date: Date | null;
+        validUntil: Date | null;
+        vehicleNo: string | null;
+        transporterId: string | null;
+        distanceKm: number | null;
+        mode: "air" | "rail" | "road" | "ship" | null;
+        error: string | null;
+    };
+}>;
+declare const MODES: {
+    readonly road: '1';
+    readonly rail: '2';
+    readonly air: '3';
+    readonly ship: '4';
+};
+/** Generates the e-way bill of a posted invoice with its transport (part B). */
+export declare function generateEwayBill(env: Env, provider: GstProvider | undefined, id: number, transport: {
+    readonly mode: keyof typeof MODES;
+    readonly distanceKm: number;
+    readonly vehicleNo: string;
+    readonly transporterId?: string | undefined;
+}): Promise<{
+    status: "cancelled" | "failed" | "registered" | null;
+    irn: string | null;
+    ackNo: string | null;
+    ackDate: Date | null;
+    signedQr: string | null;
+    cancelledAt: Date | null;
+    error: string | null;
+    ewayBill: {
+        status: "cancelled" | "failed" | "generated" | null;
+        number: string | null;
+        date: Date | null;
+        validUntil: Date | null;
+        vehicleNo: string | null;
+        transporterId: string | null;
+        distanceKm: number | null;
+        mode: "air" | "rail" | "road" | "ship" | null;
+        error: string | null;
+    };
+}>;
+/** Cancels an e-way bill within 24 hours of its generation. */
+export declare function cancelEwayBill(env: Env, provider: GstProvider | undefined, id: number, reason: string, remark: string): Promise<{
+    status: "cancelled" | "failed" | "registered" | null;
+    irn: string | null;
+    ackNo: string | null;
+    ackDate: Date | null;
+    signedQr: string | null;
+    cancelledAt: Date | null;
+    error: string | null;
+    ewayBill: {
+        status: "cancelled" | "failed" | "generated" | null;
+        number: string | null;
+        date: Date | null;
+        validUntil: Date | null;
+        vehicleNo: string | null;
+        transporterId: string | null;
+        distanceKm: number | null;
+        mode: "air" | "rail" | "road" | "ship" | null;
+        error: string | null;
+    };
+}>;
+/**
+ * After posting (`account.move.posted`): customer documents of companies with e-invoicing on are registered, those
+ * to registered recipients and abroad; a refusal stays on the document for the user to fix and retry.
+ */
+export declare function registerPosted(env: Env, provider: GstProvider, id: number): Promise<void>;
+export {};