@ingenx-io/valets-schema-mcp-server 0.2.5 → 0.2.7

package/data/docs/models/expense.md

@@ -0,0 +1,434 @@
+---
+title: "Expense"
+sidebar_label: "Expense"
+sidebar_position: 15
+---
+
+# Expense
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "title": "title",
+  "description": null,
+  "amount": 45000,
+  "currency": "XOF",
+  "dueDate": "dueDate",
+  "paymentStatus": "paymentStatus",
+  "amountDue": null,
+  "amountPaid": null,
+  "allocatedAmount": null,
+  "balance": null,
+  "paidDate": "pai_ref123",
+  "paymentReference": null,
+  "createdBy": "staff_k0f1",
+  "createdAt": "createdAt",
+  "updatedAt": "updatedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `companyId`](#companyId)
+- [3. Property `title`](#title)
+- [4. Property `description`](#description)
+- [5. Property `amount`](#amount)
+- [6. Property `currency`](#currency)
+- [7. Property `dueDate`](#dueDate)
+  - [7.1. Property `firestore-timestamp`](#dueDate_anyOf_i0)
+    - [7.1.1. Property `_seconds`](#dueDate_anyOf_i0__seconds)
+    - [7.1.2. Property `_nanoseconds`](#dueDate_anyOf_i0__nanoseconds)
+  - [7.2. Property `item 1`](#dueDate_anyOf_i1)
+- [8. Property `paymentStatus`](#paymentStatus)
+- [9. Property `amountDue`](#amountDue)
+- [10. Property `amountPaid`](#amountPaid)
+- [11. Property `allocatedAmount`](#allocatedAmount)
+- [12. Property `balance`](#balance)
+- [13. Property `paidDate`](#paidDate)
+  - [13.1. Property `firestore-timestamp`](#paidDate_anyOf_i0)
+  - [13.2. Property `item 1`](#paidDate_anyOf_i1)
+- [14. Property `paymentReference`](#paymentReference)
+- [15. Property `createdBy`](#createdBy)
+- [16. Property `createdAt`](#createdAt)
+  - [16.1. Property `firestore-timestamp`](#createdAt_anyOf_i0)
+  - [16.2. Property `item 1`](#createdAt_anyOf_i1)
+- [17. Property `updatedAt`](#updatedAt)
+  - [17.1. Property `firestore-timestamp`](#updatedAt_anyOf_i0)
+  - [17.2. Property `item 1`](#updatedAt_anyOf_i1)
+
+|                           |                       |
+| ------------------------- | --------------------- |
+| **Type**                  | `object`              |
+| **Required**              | No                    |
+| **Additional properties** | Not allowed           |
+| **Defined in**            | #/definitions/expense |
+
+**Description:** Expense (GH#12/#13/#19 partial). Collection: companies/\{companyId\}/expenses/\{expenseId\}. Dual balance tracking: amountPaid/amountDue for simple expenses; allocatedAmount/balance (server-set) for allocation-settled expenses. OVERDUE excluded from stored enum — derive at read time. Full domain (Payee FK, Contract FK) in #20.
+
+| Property                                 | Pattern | Type             | Deprecated | Definition                              | Title/Description                                                                                                        |
+| ---------------------------------------- | ------- | ---------------- | ---------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| - [id](#id )                             | No      | string or null   | No         | -                                       | (Read-only) Firestore document ID, auto-generated.                                                                       |
+| + [companyId](#companyId )               | No      | string           | No         | -                                       | (Immutable) FK → Company document ID.                                                                                    |
+| + [title](#title )                       | No      | string           | No         | -                                       | Human-readable expense title (e.g. "Loyer mars 2026", "Facture EAU").                                                    |
+| - [description](#description )           | No      | string or null   | No         | -                                       | Optional longer description or notes.                                                                                    |
+| + [amount](#amount )                     | No      | number           | No         | -                                       | Total expense amount (XOF).                                                                                              |
+| + [currency](#currency )                 | No      | const            | No         | -                                       | Currency code. Locked to XOF.                                                                                            |
+| - [dueDate](#dueDate )                   | No      | Combination      | No         | -                                       | When the expense is due. Used to compute OVERDUE state at read time (not stored in paymentStatus).                       |
+| + [paymentStatus](#paymentStatus )       | No      | enum (of string) | No         | In #/definitions/expense-payment-status | Current payment status. OVERDUE is never stored — derive from dueDate at read time (#13).                                |
+| - [amountDue](#amountDue )               | No      | number or null   | No         | -                                       | Amount still owed. Authoritative when no OutboundPaymentAllocation records exist for this expense.                       |
+| - [amountPaid](#amountPaid )             | No      | number or null   | No         | -                                       | Amount paid to date (simple tracking, no allocations).                                                                   |
+| - [allocatedAmount](#allocatedAmount )   | No      | number or null   | No         | -                                       | (Read-only) Total amount allocated via OutboundPaymentAllocation records. Authoritative when allocations exist.          |
+| - [balance](#balance )                   | No      | number or null   | No         | -                                       | (Read-only) Remaining balance: amount minus allocatedAmount. Authoritative when OutboundPaymentAllocation records exist. |
+| - [paidDate](#paidDate )                 | No      | Combination      | No         | -                                       | When the expense was fully settled (paymentStatus = PAID). Null otherwise.                                               |
+| - [paymentReference](#paymentReference ) | No      | string or null   | No         | -                                       | Most recent payment transaction reference. Overwritten on each payment; not a full history.                              |
+| + [createdBy](#createdBy )               | No      | string           | No         | -                                       | (Immutable) FK → User/staff UID who created this expense record.                                                         |
+| - [createdAt](#createdAt )               | No      | Combination      | No         | -                                       | (Read-only) Server-generated creation timestamp.                                                                         |
+| - [updatedAt](#updatedAt )               | No      | Combination      | No         | -                                       | (Read-only) Server-generated last-update timestamp.                                                                      |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID, auto-generated.
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+## <a name="companyId"></a>2. Property `companyId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Company document ID.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="title"></a>3. Property `title`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Human-readable expense title (e.g. "Loyer mars 2026", "Facture EAU").
+
+## <a name="description"></a>4. Property `description`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Optional longer description or notes.
+
+## <a name="amount"></a>5. Property `amount`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `number` |
+| **Required** | Yes      |
+
+**Description:** Total expense amount (XOF).
+
+## <a name="currency"></a>6. Property `currency`
+
+|              |         |
+| ------------ | ------- |
+| **Type**     | `const` |
+| **Required** | Yes     |
+
+**Description:** Currency code. Locked to XOF.
+
+Specific value: `"XOF"`
+
+## <a name="dueDate"></a>7. Property `dueDate`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** When the expense is due. Used to compute OVERDUE state at read time (not stored in paymentStatus).
+
+| Any of(Option)                           |
+| ---------------------------------------- |
+| [firestore-timestamp](#dueDate_anyOf_i0) |
+| [item 1](#dueDate_anyOf_i1)              |
+
+### <a name="dueDate_anyOf_i0"></a>7.1. Property `firestore-timestamp`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | No                                |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** Firestore Timestamp — Admin SDK form: \{ _seconds, _nanoseconds \}. See types/firestore.ts for REST API v1 and client SDK serialization notes (#10).
+
+| Property                                          | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#dueDate_anyOf_i0__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#dueDate_anyOf_i0__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+#### <a name="dueDate_anyOf_i0__seconds"></a>7.1.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+#### <a name="dueDate_anyOf_i0__nanoseconds"></a>7.1.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="dueDate_anyOf_i1"></a>7.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+## <a name="paymentStatus"></a>8. Property `paymentStatus`
+
+|                |                                      |
+| -------------- | ------------------------------------ |
+| **Type**       | `enum (of string)`                   |
+| **Required**   | Yes                                  |
+| **Defined in** | #/definitions/expense-payment-status |
+
+**Description:** Current payment status. OVERDUE is never stored — derive from dueDate at read time (#13).
+
+Must be one of:
+* "PENDING"
+* "PARTIALLY_PAID"
+* "PAID"
+* "FAILED"
+
+:::note
+OVERDUE is intentionally excluded — it is never stored in Firestore. Compute it at read time: expense.paymentStatus !== PAID && expense.dueDate < now() (#13). Helper: isExpenseOverdue(expense: Expense): boolean.
+:::
+
+## <a name="amountDue"></a>9. Property `amountDue`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** Amount still owed. Authoritative when no OutboundPaymentAllocation records exist for this expense.
+
+:::note
+Authoritative for simple (non-allocation) expenses. Legacy field maintained for backward compatibility when no OutboundPaymentAllocation records exist (#12).
+:::
+
+## <a name="amountPaid"></a>10. Property `amountPaid`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** Amount paid to date (simple tracking, no allocations).
+
+## <a name="allocatedAmount"></a>11. Property `allocatedAmount`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Total amount allocated via OutboundPaymentAllocation records. Authoritative when allocations exist.
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+:::note
+Server-set — computed from OutboundPaymentAllocation records. Clients must never write this field (#12).
+:::
+
+## <a name="balance"></a>12. Property `balance`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Remaining balance: amount minus allocatedAmount. Authoritative when OutboundPaymentAllocation records exist.
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+:::note
+Server-set — computed as amount - allocatedAmount. Authoritative remaining amount when allocations exist. Prefer this over amountDue when OutboundPaymentAllocation records are present (#12).
+:::
+
+## <a name="paidDate"></a>13. Property `paidDate`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** When the expense was fully settled (paymentStatus = PAID). Null otherwise.
+
+| Any of(Option)                            |
+| ----------------------------------------- |
+| [firestore-timestamp](#paidDate_anyOf_i0) |
+| [item 1](#paidDate_anyOf_i1)              |
+
+### <a name="paidDate_anyOf_i0"></a>13.1. Property `firestore-timestamp`
+
+|                           |                                       |
+| ------------------------- | ------------------------------------- |
+| **Type**                  | `object`                              |
+| **Required**              | No                                    |
+| **Additional properties** | Not allowed                           |
+| **Same definition as**    | [dueDate_anyOf_i0](#dueDate_anyOf_i0) |
+
+**Description:** Firestore Timestamp — Admin SDK form: \{ _seconds, _nanoseconds \}. See types/firestore.ts for REST API v1 and client SDK serialization notes (#10).
+
+### <a name="paidDate_anyOf_i1"></a>13.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+:::tip When to set
+Set when paymentStatus transitions to PAID (fully settled). Null for partially paid or unpaid expenses. For multi-payment history, read OutboundPaymentAllocation records (#19).
+:::
+
+## <a name="paymentReference"></a>14. Property `paymentReference`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Most recent payment transaction reference. Overwritten on each payment; not a full history.
+
+:::note
+Reference for the most recent payment transaction (check number, wire ID, Wave ref, etc.). Overwritten on each payment. For full payment history read OutboundPaymentAllocation records (#19).
+:::
+
+## <a name="createdBy"></a>15. Property `createdBy`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → User/staff UID who created this expense record.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="createdAt"></a>16. Property `createdAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Server-generated creation timestamp.
+
+| Any of(Option)                             |
+| ------------------------------------------ |
+| [firestore-timestamp](#createdAt_anyOf_i0) |
+| [item 1](#createdAt_anyOf_i1)              |
+
+### <a name="createdAt_anyOf_i0"></a>16.1. Property `firestore-timestamp`
+
+|                           |                                       |
+| ------------------------- | ------------------------------------- |
+| **Type**                  | `object`                              |
+| **Required**              | No                                    |
+| **Additional properties** | Not allowed                           |
+| **Same definition as**    | [dueDate_anyOf_i0](#dueDate_anyOf_i0) |
+
+**Description:** Firestore Timestamp — Admin SDK form: \{ _seconds, _nanoseconds \}. See types/firestore.ts for REST API v1 and client SDK serialization notes (#10).
+
+### <a name="createdAt_anyOf_i1"></a>16.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+## <a name="updatedAt"></a>17. Property `updatedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Server-generated last-update timestamp.
+
+| Any of(Option)                             |
+| ------------------------------------------ |
+| [firestore-timestamp](#updatedAt_anyOf_i0) |
+| [item 1](#updatedAt_anyOf_i1)              |
+
+### <a name="updatedAt_anyOf_i0"></a>17.1. Property `firestore-timestamp`
+
+|                           |                                       |
+| ------------------------- | ------------------------------------- |
+| **Type**                  | `object`                              |
+| **Required**              | No                                    |
+| **Additional properties** | Not allowed                           |
+| **Same definition as**    | [dueDate_anyOf_i0](#dueDate_anyOf_i0) |
+
+**Description:** Firestore Timestamp — Admin SDK form: \{ _seconds, _nanoseconds \}. See types/firestore.ts for REST API v1 and client SDK serialization notes (#10).
+
+### <a name="updatedAt_anyOf_i1"></a>17.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::

package/data/docs/models/loyalty-config.md

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyConfig"
 sidebar_label: "LoyaltyConfig"
-sidebar_position: 14
+sidebar_position: 16
 ---
 
 # LoyaltyConfig
@@ -304,7 +304,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/loyalty-reward.md

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyReward"
 sidebar_label: "LoyaltyReward"
-sidebar_position: 15
+sidebar_position: 17
 ---
 
 # LoyaltyReward
@@ -229,7 +229,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/loyalty-status.md

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyStatus"
 sidebar_label: "LoyaltyStatus"
-sidebar_position: 16
+sidebar_position: 18
 ---
 
 # LoyaltyStatus
@@ -315,7 +315,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/loyalty-transaction.md

@@ -1,7 +1,7 @@
 ---
 title: "LoyaltyTransaction"
 sidebar_label: "LoyaltyTransaction"
-sidebar_position: 17
+sidebar_position: 19
 ---
 
 # LoyaltyTransaction
@@ -313,7 +313,7 @@ Set at creation only. This field cannot be modified after the document is create
 **Description:** (Immutable, Denormalized) From User display name at creation time.
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::info Immutable
 Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.

package/data/docs/models/magic-link-request.md

@@ -1,7 +1,7 @@
 ---
 title: "MagicLinkRequest"
 sidebar_label: "MagicLinkRequest"
-sidebar_position: 18
+sidebar_position: 20
 ---
 
 # MagicLinkRequest
@@ -282,4 +282,4 @@ Set at creation only. This field cannot be modified after the document is create
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000

package/data/docs/models/metrics-current.md

@@ -1,7 +1,7 @@
 ---
 title: "MetricsCurrent"
 sidebar_label: "MetricsCurrent"
-sidebar_position: 19
+sidebar_position: 21
 ---
 
 # MetricsCurrent
@@ -172,6 +172,10 @@ Do not include in write requests. This field is set exclusively by the server (F
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
 :::
 
+:::note
+Firestore REST API v1 writes integerValue when the stored value is whole (e.g. 0), doubleValue when fractional (e.g. 82.17). Admin SDK smooths this to a JS number; REST clients must coerce the union (#11).
+:::
+
 ## <a name="todayPurchasesCount"></a>4. Property `todayPurchasesCount`
 
 |              |           |
@@ -216,6 +220,10 @@ Do not include in write requests. This field is set exclusively by the server (F
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
 :::
 
+:::note
+Firestore REST API v1 writes integerValue when whole (e.g. 10070), doubleValue when fractional (e.g. 10006.5). Admin SDK smooths this; REST clients must coerce (#11).
+:::
+
 ## <a name="monthlyRevenue"></a>7. Property `monthlyRevenue`
 
 |              |          |
@@ -229,6 +237,10 @@ Do not include in write requests. This field is set exclusively by the server (F
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
 :::
 
+:::note
+Observed as integerValue on all sampled tenants (whole XOF amounts). Will be doubleValue if fractional. REST clients must coerce (#11).
+:::
+
 ## <a name="monthlyPurchasesCount"></a>8. Property `monthlyPurchasesCount`
 
 |              |           |
@@ -322,6 +334,10 @@ Do not include in write requests. This field is set exclusively by the server (F
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
 :::
 
+:::note
+Observed as integerValue "0" on all sampled tenants. Will be doubleValue if fractional payments occur. REST clients must coerce (#11).
+:::
+
 ## <a name="todayRevenue"></a>14. Property `todayRevenue`
 
 |              |          |
@@ -438,6 +454,10 @@ Do not include in write requests. This field is set exclusively by the server (F
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
 :::
 
+:::note
+Observed as integerValue "0" on all tenants (no reviews yet). Will be doubleValue once real ratings exist. REST clients must coerce (#11).
+:::
+
 ## <a name="lowStockItemsCount"></a>21. Property `lowStockItemsCount`
 
 |              |           |
@@ -657,7 +677,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Maximum**  | &le; 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.