@ingenx-io/valets-schema-mcp-server 0.2.4 → 0.2.6

package/data/docs/models/outbound-payment-allocation.md

@@ -0,0 +1,195 @@
+---
+title: "OutboundPaymentAllocation"
+sidebar_label: "OutboundPaymentAllocation"
+sidebar_position: 27
+---
+
+# OutboundPaymentAllocation
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "outboundPaymentId": "out_ref123",
+  "expenseId": "exp_ref123",
+  "companyId": "comp_xyz789",
+  "amount": 45000,
+  "notes": null,
+  "allocatedAt": "allocatedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `outboundPaymentId`](#outboundPaymentId)
+- [3. Property `expenseId`](#expenseId)
+- [4. Property `companyId`](#companyId)
+- [5. Property `amount`](#amount)
+- [6. Property `notes`](#notes)
+- [7. Property `allocatedAt`](#allocatedAt)
+  - [7.1. Property `firestore-timestamp`](#allocatedAt_anyOf_i0)
+    - [7.1.1. Property `_seconds`](#allocatedAt_anyOf_i0__seconds)
+    - [7.1.2. Property `_nanoseconds`](#allocatedAt_anyOf_i0__nanoseconds)
+  - [7.2. Property `item 1`](#allocatedAt_anyOf_i1)
+
+|                           |                                           |
+| ------------------------- | ----------------------------------------- |
+| **Type**                  | `object`                                  |
+| **Required**              | No                                        |
+| **Additional properties** | Not allowed                               |
+| **Defined in**            | #/definitions/outbound-payment-allocation |
+
+**Description:** OutboundPaymentAllocation (GH#15). Subcollection: companies/\{companyId\}/outboundPayments/\{paymentId\}/allocations/\{allocationId\}. Links an OutboundPayment to an Expense. Supports partial and multi-expense allocations.
+
+| Property                                   | Pattern | Type           | Deprecated | Definition | Title/Description                                                                |
+| ------------------------------------------ | ------- | -------------- | ---------- | ---------- | -------------------------------------------------------------------------------- |
+| - [id](#id )                               | No      | string or null | No         | -          | (Read-only) Firestore document ID, auto-generated.                               |
+| + [outboundPaymentId](#outboundPaymentId ) | No      | string         | No         | -          | (Immutable) FK → OutboundPayment document ID (parent).                           |
+| + [expenseId](#expenseId )                 | No      | string         | No         | -          | (Immutable) FK → Expense document ID. Full Expense model tracked in #20.         |
+| + [companyId](#companyId )                 | No      | string         | No         | -          | (Immutable) FK → Company document ID. Denormalized for collection-group queries. |
+| + [amount](#amount )                       | No      | number         | No         | -          | Amount of this payment allocated to the referenced expense (XOF).                |
+| - [notes](#notes )                         | No      | string or null | No         | -          | Optional notes about this allocation.                                            |
+| - [allocatedAt](#allocatedAt )             | No      | Combination    | No         | -          | (Read-only) When this allocation was recorded.                                   |
+
+## <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="outboundPaymentId"></a>2. Property `outboundPaymentId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → OutboundPayment document ID (parent).
+
+:::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="expenseId"></a>3. Property `expenseId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Expense document ID. Full Expense model tracked in #20.
+
+:::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="companyId"></a>4. Property `companyId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Company document ID. Denormalized for collection-group queries.
+
+:::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="amount"></a>5. Property `amount`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `number` |
+| **Required** | Yes      |
+
+**Description:** Amount of this payment allocated to the referenced expense (XOF).
+
+## <a name="notes"></a>6. Property `notes`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Optional notes about this allocation.
+
+## <a name="allocatedAt"></a>7. Property `allocatedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) When this allocation was recorded.
+
+| Any of(Option)                               |
+| -------------------------------------------- |
+| [firestore-timestamp](#allocatedAt_anyOf_i0) |
+| [item 1](#allocatedAt_anyOf_i1)              |
+
+### <a name="allocatedAt_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](#allocatedAt_anyOf_i0__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#allocatedAt_anyOf_i0__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+#### <a name="allocatedAt_anyOf_i0__seconds"></a>7.1.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+#### <a name="allocatedAt_anyOf_i0__nanoseconds"></a>7.1.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="allocatedAt_anyOf_i1"></a>7.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:38:45 +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/outbound-payment.md

@@ -0,0 +1,318 @@
+---
+title: "OutboundPayment"
+sidebar_label: "OutboundPayment"
+sidebar_position: 26
+---
+
+# OutboundPayment
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "payeeId": "pay_ref123",
+  "contractId": null,
+  "amount": 45000,
+  "currency": "XOF",
+  "method": "method",
+  "reference": null,
+  "paidAt": "pai_ref123",
+  "notes": null,
+  "createdBy": "staff_k0f1",
+  "createdAt": "createdAt",
+  "updatedAt": "updatedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `companyId`](#companyId)
+- [3. Property `payeeId`](#payeeId)
+- [4. Property `contractId`](#contractId)
+- [5. Property `amount`](#amount)
+- [6. Property `currency`](#currency)
+- [7. Property `method`](#method)
+- [8. Property `reference`](#reference)
+- [9. Property `paidAt`](#paidAt)
+  - [9.1. Property `_seconds`](#paidAt__seconds)
+  - [9.2. Property `_nanoseconds`](#paidAt__nanoseconds)
+- [10. Property `notes`](#notes)
+- [11. Property `createdBy`](#createdBy)
+- [12. Property `createdAt`](#createdAt)
+  - [12.1. Property `firestore-timestamp`](#createdAt_anyOf_i0)
+  - [12.2. Property `item 1`](#createdAt_anyOf_i1)
+- [13. Property `updatedAt`](#updatedAt)
+  - [13.1. Property `firestore-timestamp`](#updatedAt_anyOf_i0)
+  - [13.2. Property `item 1`](#updatedAt_anyOf_i1)
+
+|                           |                                |
+| ------------------------- | ------------------------------ |
+| **Type**                  | `object`                       |
+| **Required**              | No                             |
+| **Additional properties** | Not allowed                    |
+| **Defined in**            | #/definitions/outbound-payment |
+
+**Description:** OutboundPayment (GH#15). Collection: companies/\{companyId\}/outboundPayments/\{paymentId\}. Single outbound transfer to a Payee. Canonical name chosen over SupplierPayment/VendorPayment — direction-based, agnostic of payee type. Currency locked to XOF.
+
+| 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.                                                                  |
+| + [payeeId](#payeeId )       | No      | string           | No         | -                                    | (Immutable) FK → Payee document ID. Full Payee model tracked in #20.                                   |
+| - [contractId](#contractId ) | No      | string or null   | No         | -                                    | (Immutable, Optional) FK → Contract document ID. Absent for ad-hoc payments outside a formal contract. |
+| + [amount](#amount )         | No      | number           | No         | -                                    | Amount paid (XOF).                                                                                     |
+| + [currency](#currency )     | No      | const            | No         | -                                    | Currency code. Locked to XOF — consistent with Contract and CustomerPayment.                           |
+| + [method](#method )         | No      | enum (of string) | No         | In #/definitions/payment-method      | Payment method used (e.g. BANK_TRANSFER, MOBILE_MONEY, CHECK).                                         |
+| - [reference](#reference )   | No      | string or null   | No         | -                                    | Optional payment reference — bank transaction number, check number, Wave ref, etc.                     |
+| + [paidAt](#paidAt )         | No      | object           | No         | In #/definitions/firestore-timestamp | When the payment was made.                                                                             |
+| - [notes](#notes )           | No      | string or null   | No         | -                                    | Optional internal notes.                                                                               |
+| + [createdBy](#createdBy )   | No      | string           | No         | -                                    | (Immutable) FK → User/staff UID who recorded the payment.                                              |
+| - [createdAt](#createdAt )   | No      | Combination      | No         | -                                    | (Read-only) Server-generated creation timestamp.                                                       |
+| - [updatedAt](#updatedAt )   | No      | Combination      | No         | -                                    | (Read-only) Server-generated 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="payeeId"></a>3. Property `payeeId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Payee document ID. Full Payee model tracked in #20.
+
+:::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="contractId"></a>4. Property `contractId`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Immutable, Optional) FK → Contract document ID. Absent for ad-hoc payments outside a formal contract.
+
+:::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="amount"></a>5. Property `amount`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `number` |
+| **Required** | Yes      |
+
+**Description:** Amount paid (XOF).
+
+## <a name="currency"></a>6. Property `currency`
+
+|              |         |
+| ------------ | ------- |
+| **Type**     | `const` |
+| **Required** | Yes     |
+
+**Description:** Currency code. Locked to XOF — consistent with Contract and CustomerPayment.
+
+Specific value: `"XOF"`
+
+## <a name="method"></a>7. Property `method`
+
+|                |                              |
+| -------------- | ---------------------------- |
+| **Type**       | `enum (of string)`           |
+| **Required**   | Yes                          |
+| **Defined in** | #/definitions/payment-method |
+
+**Description:** Payment method used (e.g. BANK_TRANSFER, MOBILE_MONEY, CHECK).
+
+Must be one of:
+* "CASH"
+* "CREDIT_CARD"
+* "ORANGE_MONEY"
+* "WAVE"
+* "MTN_MONEY"
+* "MOOV_MONEY"
+* "BANK_TRANSFER"
+* "PAYPAL"
+* "STRIPE"
+* "OTHER"
+
+## <a name="reference"></a>8. Property `reference`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Optional payment reference — bank transaction number, check number, Wave ref, etc.
+
+## <a name="paidAt"></a>9. Property `paidAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** When the payment was made.
+
+| Property                                | Pattern | Type    | Deprecated | Definition | Title/Description |
+| --------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#paidAt__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#paidAt__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="paidAt__seconds"></a>9.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="paidAt__nanoseconds"></a>9.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="notes"></a>10. Property `notes`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Optional internal notes.
+
+## <a name="createdBy"></a>11. Property `createdBy`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → User/staff UID who recorded the payment.
+
+:::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>12. 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>12.1. Property `firestore-timestamp`
+
+|                           |                   |
+| ------------------------- | ----------------- |
+| **Type**                  | `object`          |
+| **Required**              | No                |
+| **Additional properties** | Not allowed       |
+| **Same definition as**    | [paidAt](#paidAt) |
+
+**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>12.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>13. Property `updatedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Server-generated update timestamp.
+
+| Any of(Option)                             |
+| ------------------------------------------ |
+| [firestore-timestamp](#updatedAt_anyOf_i0) |
+| [item 1](#updatedAt_anyOf_i1)              |
+
+### <a name="updatedAt_anyOf_i0"></a>13.1. Property `firestore-timestamp`
+
+|                           |                   |
+| ------------------------- | ----------------- |
+| **Type**                  | `object`          |
+| **Required**              | No                |
+| **Additional properties** | Not allowed       |
+| **Same definition as**    | [paidAt](#paidAt) |
+
+**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>13.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:38:45 +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.
+:::