@kohost/api-client 7.7.0 → 7.8.0

package/dist/schemas/bill.d.ts

@@ -0,0 +1,255 @@
+import defs, { ISODateString } from "./definitions.js";
+import type { FromSchema } from "json-schema-to-ts";
+import { mediaFileSchema } from "./mediaFile.js";
+export declare const billSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema";
+    readonly $id: "bill.json";
+    readonly title: "Bill";
+    readonly description: string;
+    readonly type: "object";
+    readonly required: readonly ["id", "organizationId", "status", "currency", "lines"];
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly id: {
+            readonly $ref: "definitions.json#/definitions/id";
+        };
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["bill"];
+            readonly default: "bill";
+        };
+        readonly organizationId: {
+            readonly type: "string";
+            readonly description: string;
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly ["draft", "sent", "paid", "void"];
+            readonly default: "draft";
+            readonly description: string;
+        };
+        readonly invoiceNumber: {
+            readonly type: readonly ["string", "null"];
+            readonly default: null;
+            readonly description: string;
+        };
+        readonly period: {
+            readonly type: readonly ["string", "null"];
+            readonly default: null;
+            readonly description: string;
+        };
+        readonly currency: {
+            readonly type: "string";
+            readonly enum: readonly ["USD"];
+            readonly default: "USD";
+            readonly description: "ISO 4217 currency code. USD only in v1.";
+        };
+        readonly fileId: {
+            readonly type: readonly ["string", "null"];
+            readonly default: null;
+            readonly description: string;
+        };
+        readonly fileUrl: {
+            readonly type: readonly ["string", "null"];
+            readonly default: null;
+            readonly description: string;
+        };
+        readonly memo: {
+            readonly type: readonly ["string", "null"];
+            readonly default: null;
+            readonly description: "Internal KFC-only note. Never customer-facing; editable in any state.";
+        };
+        readonly billingAddress: {
+            readonly anyOf: readonly [{
+                readonly $ref: "definitions.json#/definitions/address";
+            }, {
+                readonly type: "null";
+            }];
+            readonly default: null;
+            readonly description: string;
+        };
+        readonly taxRate: {
+            readonly type: readonly ["number", "null"];
+            readonly default: null;
+            readonly minimum: 0;
+            readonly description: string;
+        };
+        readonly taxExempt: {
+            readonly type: "boolean";
+            readonly default: false;
+            readonly description: string;
+        };
+        readonly shippingAmount: {
+            readonly type: readonly ["integer", "null"];
+            readonly default: null;
+            readonly minimum: 0;
+            readonly description: string;
+        };
+        readonly lines: {
+            readonly type: "array";
+            readonly default: readonly [];
+            readonly description: string;
+            readonly items: {
+                readonly oneOf: readonly [{
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["id", "type", "ticketId", "costId"];
+                    readonly properties: {
+                        readonly id: {
+                            readonly type: "string";
+                            readonly description: "Server-minted ID of the bill line.";
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["cost"];
+                            readonly description: "Discriminator: a line drawn from a ticket cost entry.";
+                        };
+                        readonly ticketId: {
+                            readonly type: "string";
+                            readonly description: "The ID of the ticket the claimed cost entry lives on.";
+                        };
+                        readonly costId: {
+                            readonly type: "string";
+                            readonly description: "The ID of the claimed cost entry within the ticket.";
+                        };
+                        readonly categoryId: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly categoryName: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly adjustedAmount: {
+                            readonly type: readonly ["integer", "null"];
+                            readonly minimum: 0;
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly adjustmentReason: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly amount: {
+                            readonly type: readonly ["integer", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly description: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly taxable: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                            readonly description: string;
+                        };
+                    };
+                }, {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["id", "type", "description", "amount"];
+                    readonly properties: {
+                        readonly id: {
+                            readonly type: "string";
+                            readonly description: "Server-minted ID of the bill line.";
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["manual"];
+                            readonly description: "Discriminator: a literal, non-ticket line.";
+                        };
+                        readonly description: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                            readonly description: "The literal customer-facing description.";
+                        };
+                        readonly amount: {
+                            readonly type: "integer";
+                            readonly description: string;
+                        };
+                        readonly propertyId: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: "The property the manual line is attributed to, when it concerns one.";
+                        };
+                        readonly categoryId: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly categoryName: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: "The category name snapshotted at mark-sent.";
+                        };
+                        readonly cost: {
+                            readonly type: readonly ["integer", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly vendorId: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly vendorInvoice: {
+                            readonly anyOf: readonly [{
+                                readonly $ref: "mediaFile.json";
+                            }, {
+                                readonly type: "null";
+                            }];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly vendorInvoiceNumber: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: "The vendor's own invoice number. Internal, redacted org-side.";
+                        };
+                        readonly taxable: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                            readonly description: string;
+                        };
+                    };
+                }];
+            };
+        };
+        readonly sentAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the bill was marked sent. Absent until sent.";
+        };
+        readonly paidAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the bill was marked paid. Absent until paid.";
+        };
+        readonly voidedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the bill was voided. Absent unless voided.";
+        };
+        readonly createdAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+        };
+        readonly updatedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+        };
+    };
+};
+export type BillSchema = FromSchema<typeof billSchema, {
+    references: [typeof defs, typeof mediaFileSchema];
+    deserialize: [
+        {
+            pattern: {
+                format: "date-time";
+            };
+            output: Date | ISODateString;
+        }
+    ];
+}>;
+/** One line on a bill: a cost line or a manual line. */
+export type BillLine = NonNullable<BillSchema["lines"]>[number];

package/dist/schemas/bill.js

@@ -0,0 +1,248 @@
+const billSchema = {
+	$schema: "http://json-schema.org/draft-07/schema",
+	$id: "bill.json",
+	title: "Bill",
+	description: "A OneBill bill, stored platform-wide and stamped with its organization: KFC staff assemble billed lines from the uninvoiced cost pool (plus manual lines) into a draft, then mark it sent to freeze and reveal it to the customer. Lifecycle draft → sent → paid, plus void. Customers see a bill in-app only once sent.",
+	type: "object",
+	required: [
+		"id",
+		"organizationId",
+		"status",
+		"currency",
+		"lines"
+	],
+	additionalProperties: false,
+	properties: {
+		id: { $ref: "definitions.json#/definitions/id" },
+		type: {
+			type: "string",
+			enum: ["bill"],
+			default: "bill"
+		},
+		organizationId: {
+			type: "string",
+			description: "The organization the bill invoices. Bills live in one admin-database collection across every organization, so each carries its owner explicitly — stamped from the request context at creation, never client-supplied."
+		},
+		status: {
+			type: "string",
+			enum: [
+				"draft",
+				"sent",
+				"paid",
+				"void"
+			],
+			default: "draft",
+			description: "Lifecycle state. `sent` freezes customer-facing fields and reveals the bill to the org; `paid` records manual payment; `void` releases cost-entry claims and hides the bill from the org view. Drafts hard-delete rather than voiding."
+		},
+		invoiceNumber: {
+			type: ["string", "null"],
+			default: null,
+			description: "Kohost's own invoice number, `KB-<n>` from a single global sequence. System-assigned at mark-sent and never entered by hand: null while the bill is a draft, immutable once set. A wrong bill is corrected by void-and-reissue, so numbers gap and are never reused."
+		},
+		period: {
+			type: ["string", "null"],
+			default: null,
+			description: "Display-only month label (e.g. \"July 2026\"). A UI hint; the bill's membership is defined by its lines, not a calendar bucket."
+		},
+		currency: {
+			type: "string",
+			enum: ["USD"],
+			default: "USD",
+			description: "ISO 4217 currency code. USD only in v1."
+		},
+		fileId: {
+			type: ["string", "null"],
+			default: null,
+			description: "The generated bill PDF's media-file ID, minted atomically at mark-sent."
+		},
+		fileUrl: {
+			type: ["string", "null"],
+			default: null,
+			description: "The generated bill PDF's file-store URL, snapshotted at mark-sent alongside fileId. Held so the sent-bill surface and the sent notification email can mint a signed, unauthenticated download link without a file lookup. Unsigned on its own (a bare link 401s)."
+		},
+		memo: {
+			type: ["string", "null"],
+			default: null,
+			description: "Internal KFC-only note. Never customer-facing; editable in any state."
+		},
+		billingAddress: {
+			anyOf: [{ $ref: "definitions.json#/definitions/address" }, { type: "null" }],
+			default: null,
+			description: "The org billing address snapshotted at mark-sent. Null while drafting, when it live-reads from the Organization. Mark-sent requires a complete address (line1, city, state, postalCode)."
+		},
+		taxRate: {
+			type: ["number", "null"],
+			default: null,
+			minimum: 0,
+			description: "Tax rate as a plain float percent applied to the taxable line subtotal. While drafting, null means the platform default rate; the effective rate is snapshotted at mark-sent."
+		},
+		taxExempt: {
+			type: "boolean",
+			default: false,
+			description: "The organization's tax exemption snapshotted at mark-sent. While drafting it live-reads from the Organization."
+		},
+		shippingAmount: {
+			type: ["integer", "null"],
+			default: null,
+			minimum: 0,
+			description: "Shipping & handling in integer cents, added to the grand total on top of the line subtotal and tax. Null means none."
+		},
+		lines: {
+			type: "array",
+			default: [],
+			description: "The bill's lines: cost lines claimed from the uninvoiced pool and literal manual lines.",
+			items: { oneOf: [{
+				type: "object",
+				additionalProperties: false,
+				required: [
+					"id",
+					"type",
+					"ticketId",
+					"costId"
+				],
+				properties: {
+					id: {
+						type: "string",
+						description: "Server-minted ID of the bill line."
+					},
+					type: {
+						type: "string",
+						enum: ["cost"],
+						description: "Discriminator: a line drawn from a ticket cost entry."
+					},
+					ticketId: {
+						type: "string",
+						description: "The ID of the ticket the claimed cost entry lives on."
+					},
+					costId: {
+						type: "string",
+						description: "The ID of the claimed cost entry within the ticket."
+					},
+					categoryId: {
+						type: ["string", "null"],
+						default: null,
+						description: "The picked billing category, inherited from the claimed cost entry when the claim does not name one. Optional while drafting, required at mark-sent. Manual pick — never derived from the ticket's issue."
+					},
+					categoryName: {
+						type: ["string", "null"],
+						default: null,
+						description: "The category name snapshotted at mark-sent. Null while drafting, when it live-reads from the category library."
+					},
+					adjustedAmount: {
+						type: ["integer", "null"],
+						minimum: 0,
+						default: null,
+						description: "Optional draft-time override of the billed amount in integer cents, floored at zero, replacing the marked-up actual at display and snapshot. Requires `adjustmentReason`. A credit (below zero) is a manual line instead."
+					},
+					adjustmentReason: {
+						type: ["string", "null"],
+						default: null,
+						description: "Short required reason accompanying `adjustedAmount`, kept for the internal record."
+					},
+					amount: {
+						type: ["integer", "null"],
+						default: null,
+						description: "The billed amount in integer cents, snapshotted at mark-sent. Null while drafting, when it live-reads (marked-up actual or the adjustment) from the cost entry."
+					},
+					description: {
+						type: ["string", "null"],
+						default: null,
+						description: "The line description, snapshotted at mark-sent. Null while drafting, when it live-reads from the cost entry."
+					},
+					taxable: {
+						type: "boolean",
+						default: false,
+						description: "Whether the line's amount joins the bill's taxable subtotal. Customer-facing: locks at mark-sent."
+					}
+				}
+			}, {
+				type: "object",
+				additionalProperties: false,
+				required: [
+					"id",
+					"type",
+					"description",
+					"amount"
+				],
+				properties: {
+					id: {
+						type: "string",
+						description: "Server-minted ID of the bill line."
+					},
+					type: {
+						type: "string",
+						enum: ["manual"],
+						description: "Discriminator: a literal, non-ticket line."
+					},
+					description: {
+						type: "string",
+						minLength: 1,
+						description: "The literal customer-facing description."
+					},
+					amount: {
+						type: "integer",
+						description: "The billed amount in integer cents. May be negative, serving as a credit (reference the reason in the description)."
+					},
+					propertyId: {
+						type: ["string", "null"],
+						default: null,
+						description: "The property the manual line is attributed to, when it concerns one."
+					},
+					categoryId: {
+						type: ["string", "null"],
+						default: null,
+						description: "The picked billing category. Optional while drafting, required at mark-sent."
+					},
+					categoryName: {
+						type: ["string", "null"],
+						default: null,
+						description: "The category name snapshotted at mark-sent."
+					},
+					cost: {
+						type: ["integer", "null"],
+						default: null,
+						description: "Informational internal vendor cost in integer cents. Never derives the amount. Redacted org-side."
+					},
+					vendorId: {
+						type: ["string", "null"],
+						default: null,
+						description: "Optional reference to the org-scoped Vendor. Internal, redacted org-side."
+					},
+					vendorInvoice: {
+						anyOf: [{ $ref: "mediaFile.json" }, { type: "null" }],
+						default: null,
+						description: "The vendor's invoice file backing the line, mirroring the cost-entry field. Internal, redacted org-side."
+					},
+					vendorInvoiceNumber: {
+						type: ["string", "null"],
+						default: null,
+						description: "The vendor's own invoice number. Internal, redacted org-side."
+					},
+					taxable: {
+						type: "boolean",
+						default: false,
+						description: "Whether the line's amount joins the bill's taxable subtotal. Customer-facing: locks at mark-sent."
+					}
+				}
+			}] }
+		},
+		sentAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the bill was marked sent. Absent until sent."
+		},
+		paidAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the bill was marked paid. Absent until paid."
+		},
+		voidedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the bill was voided. Absent unless voided."
+		},
+		createdAt: { $ref: "definitions.json#/definitions/date" },
+		updatedAt: { $ref: "definitions.json#/definitions/date" }
+	}
+};
+//#endregion
+export { billSchema };
+
+//# sourceMappingURL=bill.js.map

package/dist/schemas/bill.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bill.js","names":[],"sources":["../../.generated/schemas/bill.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\nimport { mediaFileSchema } from \"./mediaFile\";\n\n// One bill line is a discriminated union on `type`, so `lines.items` is their\n// `oneOf`. The two branches are disjoint via the `type` const plus\n// `additionalProperties: false`, so a line validates against exactly one.\n//\n// A cost line references a ticket cost entry by `(ticketId, costId)`. While the\n// bill is a draft it carries only the reference, the picked `categoryId`, and\n// any draft-time adjustment; the customer-facing `amount`, `description`, and\n// `categoryName` are live-read from the cost entry and snapshotted onto the\n// line at mark-sent. The billed amount is the marked-up actual (or the\n// `adjustedAmount` override, floored at zero) — vendor truth on the cost entry\n// is never touched.\nconst costLineSchema = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"id\", \"type\", \"ticketId\", \"costId\"],\n  properties: {\n    id: {\n      type: \"string\",\n      description: \"Server-minted ID of the bill line.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"cost\"],\n      description: \"Discriminator: a line drawn from a ticket cost entry.\",\n    },\n    ticketId: {\n      type: \"string\",\n      description: \"The ID of the ticket the claimed cost entry lives on.\",\n    },\n    costId: {\n      type: \"string\",\n      description: \"The ID of the claimed cost entry within the ticket.\",\n    },\n    categoryId: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The picked billing category, inherited from the claimed cost entry \" +\n        \"when the claim does not name one. Optional while drafting, required \" +\n        \"at mark-sent. Manual pick — never derived from the ticket's issue.\",\n    },\n    categoryName: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The category name snapshotted at mark-sent. Null while drafting, \" +\n        \"when it live-reads from the category library.\",\n    },\n    adjustedAmount: {\n      type: [\"integer\", \"null\"],\n      minimum: 0,\n      default: null,\n      description:\n        \"Optional draft-time override of the billed amount in integer cents, \" +\n        \"floored at zero, replacing the marked-up actual at display and \" +\n        \"snapshot. Requires `adjustmentReason`. A credit (below zero) is a \" +\n        \"manual line instead.\",\n    },\n    adjustmentReason: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"Short required reason accompanying `adjustedAmount`, kept for the \" +\n        \"internal record.\",\n    },\n    amount: {\n      type: [\"integer\", \"null\"],\n      default: null,\n      description:\n        \"The billed amount in integer cents, snapshotted at mark-sent. Null \" +\n        \"while drafting, when it live-reads (marked-up actual or the \" +\n        \"adjustment) from the cost entry.\",\n    },\n    description: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The line description, snapshotted at mark-sent. Null while drafting, \" +\n        \"when it live-reads from the cost entry.\",\n    },\n    taxable: {\n      type: \"boolean\",\n      default: false,\n      description:\n        \"Whether the line's amount joins the bill's taxable subtotal. \" +\n        \"Customer-facing: locks at mark-sent.\",\n    },\n  },\n} as const;\n\n// A manual line is a literal customer-facing row with no markup math: a\n// `description` and `amount` (which may be negative, serving as a credit) and\n// an optional `propertyId`. The independent internal fields — informational\n// `cost` (never derives the amount), `vendorId`, the vendor-invoice file, and\n// `vendorInvoiceNumber` — are redacted org-side via `canSeeCostSplit` and stay\n// editable in any bill state.\nconst manualLineSchema = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"id\", \"type\", \"description\", \"amount\"],\n  properties: {\n    id: {\n      type: \"string\",\n      description: \"Server-minted ID of the bill line.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"manual\"],\n      description: \"Discriminator: a literal, non-ticket line.\",\n    },\n    description: {\n      type: \"string\",\n      minLength: 1,\n      description: \"The literal customer-facing description.\",\n    },\n    amount: {\n      type: \"integer\",\n      description:\n        \"The billed amount in integer cents. May be negative, serving as a \" +\n        \"credit (reference the reason in the description).\",\n    },\n    propertyId: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The property the manual line is attributed to, when it concerns one.\",\n    },\n    categoryId: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The picked billing category. Optional while drafting, required at \" +\n        \"mark-sent.\",\n    },\n    categoryName: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description: \"The category name snapshotted at mark-sent.\",\n    },\n    cost: {\n      type: [\"integer\", \"null\"],\n      default: null,\n      description:\n        \"Informational internal vendor cost in integer cents. Never derives \" +\n        \"the amount. Redacted org-side.\",\n    },\n    vendorId: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"Optional reference to the org-scoped Vendor. Internal, redacted \" +\n        \"org-side.\",\n    },\n    vendorInvoice: {\n      anyOf: [{ $ref: \"mediaFile.json\" }, { type: \"null\" }],\n      default: null,\n      description:\n        \"The vendor's invoice file backing the line, mirroring the cost-entry \" +\n        \"field. Internal, redacted org-side.\",\n    },\n    vendorInvoiceNumber: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The vendor's own invoice number. Internal, redacted org-side.\",\n    },\n    taxable: {\n      type: \"boolean\",\n      default: false,\n      description:\n        \"Whether the line's amount joins the bill's taxable subtotal. \" +\n        \"Customer-facing: locks at mark-sent.\",\n    },\n  },\n} as const;\n\nexport const billSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"bill.json\",\n  title: \"Bill\",\n  description:\n    \"A OneBill bill, stored platform-wide and stamped with its organization: \" +\n    \"KFC staff assemble billed lines from the \" +\n    \"uninvoiced cost pool (plus manual lines) into a draft, then mark it sent \" +\n    \"to freeze and reveal it to the customer. Lifecycle draft → sent → paid, \" +\n    \"plus void. Customers see a bill in-app only once sent.\",\n  type: \"object\",\n  required: [\"id\", \"organizationId\", \"status\", \"currency\", \"lines\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"bill\"],\n      default: \"bill\",\n    },\n    organizationId: {\n      type: \"string\",\n      description:\n        \"The organization the bill invoices. Bills live in one admin-database \" +\n        \"collection across every organization, so each carries its owner \" +\n        \"explicitly — stamped from the request context at creation, never \" +\n        \"client-supplied.\",\n    },\n    status: {\n      type: \"string\",\n      enum: [\"draft\", \"sent\", \"paid\", \"void\"],\n      default: \"draft\",\n      description:\n        \"Lifecycle state. `sent` freezes customer-facing fields and reveals \" +\n        \"the bill to the org; `paid` records manual payment; `void` releases \" +\n        \"cost-entry claims and hides the bill from the org view. Drafts \" +\n        \"hard-delete rather than voiding.\",\n    },\n    invoiceNumber: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"Kohost's own invoice number, `KB-<n>` from a single global sequence. \" +\n        \"System-assigned at mark-sent and never entered by hand: null while \" +\n        \"the bill is a draft, immutable once set. A wrong bill is corrected \" +\n        \"by void-and-reissue, so numbers gap and are never reused.\",\n    },\n    period: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        'Display-only month label (e.g. \"July 2026\"). A UI hint; the bill\\'s ' +\n        \"membership is defined by its lines, not a calendar bucket.\",\n    },\n    currency: {\n      type: \"string\",\n      enum: [\"USD\"],\n      default: \"USD\",\n      description: \"ISO 4217 currency code. USD only in v1.\",\n    },\n    fileId: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The generated bill PDF's media-file ID, minted atomically at \" +\n        \"mark-sent.\",\n    },\n    fileUrl: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"The generated bill PDF's file-store URL, snapshotted at mark-sent \" +\n        \"alongside fileId. Held so the sent-bill surface and the sent \" +\n        \"notification email can mint a signed, unauthenticated download link \" +\n        \"without a file lookup. Unsigned on its own (a bare link 401s).\",\n    },\n    memo: {\n      type: [\"string\", \"null\"],\n      default: null,\n      description:\n        \"Internal KFC-only note. Never customer-facing; editable in any state.\",\n    },\n    billingAddress: {\n      anyOf: [\n        { $ref: \"definitions.json#/definitions/address\" },\n        { type: \"null\" },\n      ],\n      default: null,\n      description:\n        \"The org billing address snapshotted at mark-sent. Null while \" +\n        \"drafting, when it live-reads from the Organization. Mark-sent \" +\n        \"requires a complete address (line1, city, state, postalCode).\",\n    },\n    taxRate: {\n      type: [\"number\", \"null\"],\n      default: null,\n      minimum: 0,\n      description:\n        \"Tax rate as a plain float percent applied to the taxable line \" +\n        \"subtotal. While drafting, null means the platform default rate; the \" +\n        \"effective rate is snapshotted at mark-sent.\",\n    },\n    taxExempt: {\n      type: \"boolean\",\n      default: false,\n      description:\n        \"The organization's tax exemption snapshotted at mark-sent. While \" +\n        \"drafting it live-reads from the Organization.\",\n    },\n    shippingAmount: {\n      type: [\"integer\", \"null\"],\n      default: null,\n      minimum: 0,\n      description:\n        \"Shipping & handling in integer cents, added to the grand total on \" +\n        \"top of the line subtotal and tax. Null means none.\",\n    },\n    lines: {\n      type: \"array\",\n      default: [],\n      description:\n        \"The bill's lines: cost lines claimed from the uninvoiced pool and \" +\n        \"literal manual lines.\",\n      items: {\n        oneOf: [costLineSchema, manualLineSchema],\n      },\n    },\n    sentAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the bill was marked sent. Absent until sent.\",\n    },\n    paidAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the bill was marked paid. Absent until paid.\",\n    },\n    voidedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the bill was voided. Absent unless voided.\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n} as const;\n\nexport type BillSchema = FromSchema<\n  typeof billSchema,\n  {\n    references: [typeof defs, typeof mediaFileSchema];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n\n/** One line on a bill: a cost line or a manual line. */\nexport type BillLine = NonNullable<BillSchema[\"lines\"]>[number];\n"],"mappings":"AAoLA,MAAa,aAAa;CACxB,SAAS;CACT,KAAK;CACL,OAAO;CACP,aACE;CAKF,MAAM;CACN,UAAU;EAAC;EAAM;EAAkB;EAAU;EAAY;CAAO;CAChE,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,MAAM;GACb,SAAS;EACX;EACA,gBAAgB;GACd,MAAM;GACN,aACE;EAIJ;EACA,QAAQ;GACN,MAAM;GACN,MAAM;IAAC;IAAS;IAAQ;IAAQ;GAAM;GACtC,SAAS;GACT,aACE;EAIJ;EACA,eAAe;GACb,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,aACE;EAIJ;EACA,QAAQ;GACN,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,aACE;EAEJ;EACA,UAAU;GACR,MAAM;GACN,MAAM,CAAC,KAAK;GACZ,SAAS;GACT,aAAa;EACf;EACA,QAAQ;GACN,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,aACE;EAEJ;EACA,SAAS;GACP,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,aACE;EAIJ;EACA,MAAM;GACJ,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,aACE;EACJ;EACA,gBAAgB;GACd,OAAO,CACL,EAAE,MAAM,wCAAwC,GAChD,EAAE,MAAM,OAAO,CACjB;GACA,SAAS;GACT,aACE;EAGJ;EACA,SAAS;GACP,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,SAAS;GACT,aACE;EAGJ;EACA,WAAW;GACT,MAAM;GACN,SAAS;GACT,aACE;EAEJ;EACA,gBAAgB;GACd,MAAM,CAAC,WAAW,MAAM;GACxB,SAAS;GACT,SAAS;GACT,aACE;EAEJ;EACA,OAAO;GACL,MAAM;GACN,SAAS,CAAC;GACV,aACE;GAEF,OAAO,EACL,OAAO,CAAC;IAlSd,MAAM;IACN,sBAAsB;IACtB,UAAU;KAAC;KAAM;KAAQ;KAAY;IAAQ;IAC7C,YAAY;KACV,IAAI;MACF,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,MAAM,CAAC,MAAM;MACb,aAAa;KACf;KACA,UAAU;MACR,MAAM;MACN,aAAa;KACf;KACA,QAAQ;MACN,MAAM;MACN,aAAa;KACf;KACA,YAAY;MACV,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KAGJ;KACA,cAAc;MACZ,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KAEJ;KACA,gBAAgB;MACd,MAAM,CAAC,WAAW,MAAM;MACxB,SAAS;MACT,SAAS;MACT,aACE;KAIJ;KACA,kBAAkB;MAChB,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KAEJ;KACA,QAAQ;MACN,MAAM,CAAC,WAAW,MAAM;MACxB,SAAS;MACT,aACE;KAGJ;KACA,aAAa;MACX,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KAEJ;KACA,SAAS;MACP,MAAM;MACN,SAAS;MACT,aACE;KAEJ;IACF;GAuNc,GAAgB;IA7M9B,MAAM;IACN,sBAAsB;IACtB,UAAU;KAAC;KAAM;KAAQ;KAAe;IAAQ;IAChD,YAAY;KACV,IAAI;MACF,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,MAAM,CAAC,QAAQ;MACf,aAAa;KACf;KACA,aAAa;MACX,MAAM;MACN,WAAW;MACX,aAAa;KACf;KACA,QAAQ;MACN,MAAM;MACN,aACE;KAEJ;KACA,YAAY;MACV,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KACJ;KACA,YAAY;MACV,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KAEJ;KACA,cAAc;MACZ,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aAAa;KACf;KACA,MAAM;MACJ,MAAM,CAAC,WAAW,MAAM;MACxB,SAAS;MACT,aACE;KAEJ;KACA,UAAU;MACR,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KAEJ;KACA,eAAe;MACb,OAAO,CAAC,EAAE,MAAM,iBAAiB,GAAG,EAAE,MAAM,OAAO,CAAC;MACpD,SAAS;MACT,aACE;KAEJ;KACA,qBAAqB;MACnB,MAAM,CAAC,UAAU,MAAM;MACvB,SAAS;MACT,aACE;KACJ;KACA,SAAS;MACP,MAAM;MACN,SAAS;MACT,aACE;KAEJ;IACF;GAiI8B,CAAgB,EAC1C;EACF;EACA,QAAQ;GACN,MAAM;GACN,aAAa;EACf;EACA,QAAQ;GACN,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;EACf;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;AACF"}

package/dist/schemas/billingCategory.d.ts

@@ -0,0 +1,46 @@
+import defs, { ISODateString } from "./definitions.js";
+import type { FromSchema } from "json-schema-to-ts";
+export declare const billingCategorySchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema";
+    readonly $id: "billingCategory.json";
+    readonly title: "Billing Category";
+    readonly description: "A label in the global, KFC-maintained billing category library, picked per bill line while drafting (e.g. \"HVAC System Maintenance/Repair\"). Named distinctly from the generic `category` schema (space/product/media discriminators). Archived, never deleted.";
+    readonly type: "object";
+    readonly required: readonly ["id", "name"];
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly id: {
+            readonly $ref: "definitions.json#/definitions/id";
+            readonly description: "Unique identifier for the Billing Category.";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Display name shown in the drafting picker and on bill lines/PDFs. Renames apply to drafts; sent bills keep their snapshotted name.";
+        };
+        readonly archived: {
+            readonly type: "boolean";
+            readonly default: false;
+            readonly description: "Archived categories leave the drafting picker but a draft line already holding one stays valid at send. Archive instead of delete: a category may be referenced by sent bills forever.";
+        };
+        readonly createdAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the Billing Category was created.";
+        };
+        readonly updatedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the Billing Category was last modified.";
+        };
+    };
+};
+export type BillingCategorySchema = FromSchema<typeof billingCategorySchema, {
+    references: [typeof defs];
+    deserialize: [
+        {
+            pattern: {
+                format: "date-time";
+            };
+            output: Date | ISODateString;
+        }
+    ];
+}>;

package/dist/schemas/billingCategory.js

@@ -0,0 +1,38 @@
+//#region .generated/schemas/billingCategory.ts
+const billingCategorySchema = {
+	$schema: "http://json-schema.org/draft-07/schema",
+	$id: "billingCategory.json",
+	title: "Billing Category",
+	description: "A label in the global, KFC-maintained billing category library, picked per bill line while drafting (e.g. \"HVAC System Maintenance/Repair\"). Named distinctly from the generic `category` schema (space/product/media discriminators). Archived, never deleted.",
+	type: "object",
+	required: ["id", "name"],
+	additionalProperties: false,
+	properties: {
+		id: {
+			$ref: "definitions.json#/definitions/id",
+			description: "Unique identifier for the Billing Category."
+		},
+		name: {
+			type: "string",
+			minLength: 1,
+			description: "Display name shown in the drafting picker and on bill lines/PDFs. Renames apply to drafts; sent bills keep their snapshotted name."
+		},
+		archived: {
+			type: "boolean",
+			default: false,
+			description: "Archived categories leave the drafting picker but a draft line already holding one stays valid at send. Archive instead of delete: a category may be referenced by sent bills forever."
+		},
+		createdAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the Billing Category was created."
+		},
+		updatedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the Billing Category was last modified."
+		}
+	}
+};
+//#endregion
+export { billingCategorySchema };
+
+//# sourceMappingURL=billingCategory.js.map

package/dist/schemas/billingCategory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billingCategory.js","names":[],"sources":["../../.generated/schemas/billingCategory.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const billingCategorySchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"billingCategory.json\",\n  title: \"Billing Category\",\n  description:\n    \"A label in the global, KFC-maintained billing category library, picked per bill line while drafting (e.g. \\\"HVAC System Maintenance/Repair\\\"). Named distinctly from the generic `category` schema (space/product/media discriminators). Archived, never deleted.\",\n  type: \"object\",\n  required: [\"id\", \"name\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n      description: \"Unique identifier for the Billing Category.\",\n    },\n    name: {\n      type: \"string\",\n      minLength: 1,\n      description:\n        \"Display name shown in the drafting picker and on bill lines/PDFs. Renames apply to drafts; sent bills keep their snapshotted name.\",\n    },\n    archived: {\n      type: \"boolean\",\n      default: false,\n      description:\n        \"Archived categories leave the drafting picker but a draft line already holding one stays valid at send. Archive instead of delete: a category may be referenced by sent bills forever.\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the Billing Category was created.\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the Billing Category was last modified.\",\n    },\n  },\n} as const;\n\nexport type BillingCategorySchema = FromSchema<\n  typeof billingCategorySchema,\n  {\n    references: [typeof defs];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAGA,MAAa,wBAAwB;CACnC,SAAS;CACT,KAAK;CACL,OAAO;CACP,aACE;CACF,MAAM;CACN,UAAU,CAAC,MAAM,MAAM;CACvB,sBAAsB;CACtB,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,WAAW;GACX,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,SAAS;GACT,aACE;EACJ;EACA,WAAW;GACT,MAAM;GACN,aAAa;EACf;EACA,WAAW;GACT,MAAM;GACN,aAAa;EACf;CACF;AACF"}

package/dist/schemas/definitions.d.ts

@@ -1,4 +1,4 @@
-export declare const TICKET_NOTIFICATION_EVENTS: readonly ["ticketCreated", "ticketAssignedToMe", "addedAsCollaborator", "mentionedInTicket", "messageOnMyTicket", "ticketResolved", "ticketCreatedAsObserver", "messageAsObserver", "ticketResolvedAsObserver"];
+export declare const TICKET_NOTIFICATION_EVENTS: readonly ["ticketCreated", "ticketAssignedToMe", "addedAsCollaborator", "mentionedInTicket", "messageOnMyTicket", "ticketResolved", "ticketCreatedAsObserver", "messageAsObserver", "ticketResolvedAsObserver", "approvalRequested", "approvalDecided"];
 export type TicketNotificationEvent = (typeof TICKET_NOTIFICATION_EVENTS)[number];
 export declare const NOTIFICATION_CHANNELS: readonly ["email", "sms", "push"];
 export type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];
@@ -79,7 +79,7 @@ declare const defs: {
         readonly driver: {
             readonly type: "string";
             readonly description: "Driver used to communicate with the object.";
-            readonly enum: readonly ["adlink", "avigilon-alta", "aws-kinesis", "bacnet", "benq", "butler", "comelit", "cool-automation", "crestron", "dell", "digital-watchdog", "distech", "dmp", "doorbird", "dormakaba", "dsc", "dsc-itv2", "earbridge", "ecobee", "epson", "geovision-rs", "geovision-as-manager", "honeywell-vista", "honeywell-resideo", "igor", "inncom", "isapi", "kohost-k7", "kohost", "lapi", "lg", "lg-webos", "linortek", "lirc", "mews", "mht", "mobile-mule", "mock", "modbus", "napco", "newline", "obix", "one-roster", "onvif", "orchid-fusion", "paxton", "pdk", "pelican-wireless", "power-shades", "rachio", "rebrandly", "relay", "reolink", "rtsp", "salto", "salto-irn", "samsung", "se", "sendgrid", "singlewire", "smartboard", "sonifi", "stay-n-touch", "storable", "twilio", "unifi", "valcom", "veracross", "verkada", "vivotek", "vizio", "wisenet", "zkteco", "cloudflare-images", "cloudflare-stream", "insperia-privacy"];
+            readonly enum: readonly ["adlink", "apex-american-audio", "avigilon-alta", "aws-kinesis", "bacnet", "benq", "butler", "comelit", "cool-automation", "crestron", "dell", "digital-watchdog", "distech", "dmp", "doorbird", "dormakaba", "dsc", "dsc-itv2", "earbridge", "ecobee", "epson", "geovision-rs", "geovision-as-manager", "honeywell-vista", "honeywell-resideo", "igor", "inncom", "isapi", "kohost-k7", "kohost", "lapi", "lg", "lg-webos", "linortek", "lirc", "mews", "mht", "mobile-mule", "mock", "modbus", "napco", "newline", "obix", "one-roster", "onvif", "orchid-fusion", "paxton", "pdk", "pelican-wireless", "power-shades", "rachio", "rebrandly", "relay", "reolink", "rtsp", "salto", "salto-irn", "samsung", "se", "sendgrid", "singlewire", "smartboard", "sonifi", "stay-n-touch", "storable", "twilio", "unifi", "valcom", "veracross", "verkada", "vivotek", "vizio", "wisenet", "zkteco", "cloudflare-images", "cloudflare-stream", "insperia-privacy"];
         };
         readonly type: {
             readonly type: "string";
@@ -171,7 +171,7 @@ declare const defs: {
         };
         readonly ticketNotificationEvent: {
             readonly type: "string";
-            readonly enum: readonly ["ticketCreated", "ticketAssignedToMe", "addedAsCollaborator", "mentionedInTicket", "messageOnMyTicket", "ticketResolved", "ticketCreatedAsObserver", "messageAsObserver", "ticketResolvedAsObserver"];
+            readonly enum: readonly ["ticketCreated", "ticketAssignedToMe", "addedAsCollaborator", "mentionedInTicket", "messageOnMyTicket", "ticketResolved", "ticketCreatedAsObserver", "messageAsObserver", "ticketResolvedAsObserver", "approvalRequested", "approvalDecided"];
         };
         readonly notificationChannel: {
             readonly type: "string";