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

package/data/static/llms.txt

@@ -22,6 +22,10 @@ Values: ACTIVE, STALE, ON_HOLD, ESCALATED
 Booking lifecycle status. COMPLETED_MIXED = some sessions completed, others cancelled/no-show.
 Values: PENDING, CONFIRMED, COMPLETED, CANCELLED, CANCELLATION_REQUESTED, COMPLETED_MIXED
 
+### ContractStatus
+Lifecycle status of a Contract. DRAFT = not yet signed. ACTIVE = in force. COMPLETED = all milestones paid and obligations met. TERMINATED = ended early by either party.
+Values: DRAFT, ACTIVE, COMPLETED, TERMINATED
+
 ### CustomerPaymentStatus
 Customer payment lifecycle status (D22). Tracks allocation progress of received payments.
 Values: PENDING, CONFIRMED, PARTIALLY_APPLIED, FULLY_APPLIED, REFUNDED, CANCELLED
@@ -50,6 +54,10 @@ Values: PREPARING, PARTIALLY_SHIPPED, SHIPPED, IN_TRANSIT, DELIVERED, PICKED_UP
 Loyalty point transaction type (D07). SCREAMING_SNAKE past tense.
 Values: EARNED, REDEEMED, ADJUSTED, EXPIRED, BONUS, REFUND
 
+### MilestoneStatus
+Status of a ContractMilestone (#17). PENDING = created, not yet invoiced. INVOICED = invoice issued, awaiting payment. PAID = payment received.
+Values: PENDING, INVOICED, PAID
+
 ### NotificationChannel
 Delivery channel of a NotificationRecord (GH#48).
 Values: email, whatsapp, sms, push
@@ -123,7 +131,7 @@ Event ticket status (D32). VALID = active and unused.
 Values: VALID, USED, CANCELLED
 
 ### WabaLabel
-Human-readable WABA label identifying which Meta business number received the message (GH#36).
+WABA label identifying which Meta Business Account sent/received the message. cmz = Chez Miss Zahoui sender; val = Valets sender. See WhatsApp platform constraints doc (#50).
 Values: cmz, val
 
 ### WhatsappButtonSubType
@@ -361,7 +369,7 @@ Example:
 ```
 
 ### App
-Fields: 14 (6 required)
+Fields: 14 (5 required)
 
 | Field | Type | Required | Description |
 |-------|------|----------|-------------|
@@ -369,7 +377,7 @@ Fields: 14 (6 required)
 | companyId | string | yes | (Immutable) FK → Company document ID. Scopes all app sub-collections. |
 | name | string | yes | Human-readable app name shown in dashboards. |
 | description | ['string', 'null'] | no | Optional freeform description. |
-| status | AppStatus | yes | Lifecycle status (D41/D44). Clients filter by ACTIVE. |
+| status | any | no | Lifecycle status (D41/D44). Optional pending backfill of pre-existing records (#26) — treat absent as ACTIVE. Clients filter by ACTIVE. |
 | deploymentLinks | array<object> | yes | Ordered list of deployment URLs (web, mobile, PWA, store links). |
 | deploymentLinks[].label | string | yes | Human-readable label shown in dashboards (e.g. "Production", "Staging"). |
 | deploymentLinks[].url | string | yes | Absolute URL or store link. |
@@ -642,6 +650,48 @@ Example:
 }
 ```
 
+### Contract
+Fields: 15 (8 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| id | ['string', 'null'] | no | (Read-only) Firestore document ID, auto-generated. |
+| companyId | string | yes | (Immutable) FK → Company document ID. |
+| payeeId | string | yes | (Immutable) FK → Payee document ID. Full Payee model tracked in #20. |
+| title | string | yes | Contract title or reference name shown in dashboards. |
+| description | ['string', 'null'] | no | Optional freeform description of the contract scope. |
+| status | ContractStatus | yes | Contract lifecycle status (#14). Query by ACTIVE — do not use an isActive boolean. |
+| currency | string | yes | Currency code. Locked to XOF (#18). Multi-currency support requires a deliberate schema version bump. |
+| totalAmount | number | yes | Total contract value (XOF). |
+| startDate | string | yes | Contract start date (ISO 8601 YYYY-MM-DD). |
+| endDate | ['string', 'null'] | no | Contract end date (ISO 8601 YYYY-MM-DD). Absent for open-ended contracts. |
+| milestones | ['array', 'null'] | no | Ordered list of payment milestones. Embedded in the contract document (#17). |
+| notes | ['string', 'null'] | no | Optional internal notes. |
+| createdBy | string | yes | (Immutable) FK → User/staff UID who created the contract. |
+| createdAt | any | no | (Read-only) Server-generated creation timestamp. |
+| updatedAt | any | no | (Read-only) Server-generated update timestamp. |
+
+Example:
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "payeeId": "pay_ref123",
+  "title": "title",
+  "description": null,
+  "status": "status",
+  "currency": "XOF",
+  "totalAmount": 45000,
+  "startDate": "2026-02-15",
+  "endDate": null,
+  "milestones": null,
+  "notes": null,
+  "createdBy": "staff_k0f1",
+  "createdAt": "createdAt",
+  "updatedAt": "updatedAt"
+}
+```
+
 ### Customer
 Fields: 17 (4 required)
 
@@ -1281,7 +1331,7 @@ Example:
 ```
 
 ### Order
-Fields: 48 (8 required)
+Fields: 49 (8 required)
 
 | Field | Type | Required | Description |
 |-------|------|----------|-------------|
@@ -1290,6 +1340,7 @@ Fields: 48 (8 required)
 | companyId | string | yes | (Immutable) FK → Company document ID. Scopes all queries. |
 | appId | ['string', 'null'] | no | (Immutable, Optional) FK → App document ID (D43 / ADR-003, renamed from siteId per D44). null = company-wide. |
 | orderNumber | string | yes | (Read-only) Server-generated order number. |
+| followUpUrl | ['string', 'null'] | no | Optional URL for receipt QR code / post-order follow-up. Canonical casing: followUpUrl (#6). |
 | status | OrderStatus | yes | Core lifecycle status (D34, MIG-11). See OrderStatus enum for the legacy value migration mapping. |
 | paymentStatus | any | no | Payment lifecycle (D34). Null until payment is initiated. |
 | fulfillmentStatus | any | no | Delivery/fulfillment lifecycle (D34). |
@@ -1342,6 +1393,7 @@ Example:
   "companyId": "comp_xyz789",
   "appId": null,
   "orderNumber": "ORD-2026-0042",
+  "followUpUrl": null,
   "status": "status",
   "paymentStatus": "paymentStatus",
   "fulfillmentStatus": "fulfillmentStatus",
@@ -1424,6 +1476,94 @@ Example:
 }
 ```
 
+### OutboundPayment
+Fields: 13 (7 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| id | ['string', 'null'] | no | (Read-only) Firestore document ID, auto-generated. |
+| companyId | string | yes | (Immutable) FK → Company document ID. |
+| payeeId | string | yes | (Immutable) FK → Payee document ID. Full Payee model tracked in #20. |
+| contractId | ['string', 'null'] | no | (Immutable, Optional) FK → Contract document ID. Absent for ad-hoc payments outside a formal contract. |
+| amount | number | yes | Amount paid (XOF). |
+| currency | string | yes | Currency code. Locked to XOF — consistent with Contract and CustomerPayment. |
+| method | PaymentMethod | yes | Payment method used (e.g. BANK_TRANSFER, MOBILE_MONEY, CHECK). |
+| reference | ['string', 'null'] | no | Optional payment reference — bank transaction number, check number, Wave ref, etc. |
+| paidAt | FirestoreTimestamp | yes | When the payment was made. |
+| notes | ['string', 'null'] | no | Optional internal notes. |
+| createdBy | string | yes | (Immutable) FK → User/staff UID who recorded the payment. |
+| createdAt | any | no | (Read-only) Server-generated creation timestamp. |
+| updatedAt | any | no | (Read-only) Server-generated update timestamp. |
+
+Example:
+```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"
+}
+```
+
+### OutboundPaymentAllocation
+Fields: 7 (4 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| id | ['string', 'null'] | no | (Read-only) Firestore document ID, auto-generated. |
+| outboundPaymentId | string | yes | (Immutable) FK → OutboundPayment document ID (parent). |
+| expenseId | string | yes | (Immutable) FK → Expense document ID. Full Expense model tracked in #20. |
+| companyId | string | yes | (Immutable) FK → Company document ID. Denormalized for collection-group queries. |
+| amount | number | yes | Amount of this payment allocated to the referenced expense (XOF). |
+| notes | ['string', 'null'] | no | Optional notes about this allocation. |
+| allocatedAt | any | no | (Read-only) When this allocation was recorded. |
+
+Example:
+```json
+{
+  "id": null,
+  "outboundPaymentId": "out_ref123",
+  "expenseId": "exp_ref123",
+  "companyId": "comp_xyz789",
+  "amount": 45000,
+  "notes": null,
+  "allocatedAt": "allocatedAt"
+}
+```
+
+### PaymentWebhookEndpoint
+Fields: 6 (5 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| token | string | yes | (Immutable) base64url-encoded 24-byte random token. Also the Firestore document ID and the URL path segment. |
+| company | string | yes | (Immutable) Company slug (e.g. gerko_studios). Identifies the tenant that owns this endpoint. |
+| provider | enum(2) | yes | (Immutable) Payment provider whose webhooks this endpoint accepts. |
+| secret | string | yes | Webhook signing secret for HMAC verification. Backend-only — never returned to dashboard or mobile clients. |
+| active | boolean | yes | Whether this endpoint is currently active. Inactive endpoints reject incoming webhooks. |
+| createdAt | any | no | (Read-only) When this endpoint was provisioned. |
+
+Example:
+```json
+{
+  "token": "token",
+  "company": "company",
+  "provider": "wave",
+  "secret": "secret",
+  "active": true,
+  "createdAt": "createdAt"
+}
+```
+
 ### Sale
 Fields: 12 (1 required)
 
@@ -1792,7 +1932,7 @@ Fields: 18 (7 required)
 | Field | Type | Required | Description |
 |-------|------|----------|-------------|
 | id | ['string', 'null'] | no | (Read-only) Firestore document ID — auto-generated at enqueue time. |
-| to | string | yes | (Immutable) Recipient phone number in E.164 format. Must match the inbound `from` for the same conversation. |
+| to | string | yes | (Immutable) Recipient Meta wa_id — digits only, no leading + (e.g. 22577471485). Equal to the inbound `from` for the same conversation. NOT literal E.164; see x-note (#54). |
 | waba | WabaLabel | yes | (Immutable) WABA that will send the message. Mirrors inbound `waba`. |
 | wabaId | string | yes | (Immutable) Meta WABA ID. Mirrors inbound `wabaId`. |
 | kind | OutboundMessageFormat | yes | (Immutable) Message format: `text` or `template`. Set `text` xor `template` to match. |