> ## Documentation Index > Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt > Use this file to discover all available pages before exploring further. # Check > Check represents a paper cheque instrument within the Well financial graph Check represents a paper cheque instrument within the Well financial graph. It captures the identifying information printed on a physical cheque โ€” the CMC7 magnetic-ink line, the check number, and the issue date โ€” and ties the instrument to either a Company or a Person (the cheque holder) and to the Workspace that owns the record. Checks are referenced by PaymentMeans rows so that a payment settled by cheque can link back to the originating instrument. | Naming | Value | | ------------------------------- | ------------ | | Object | Check | | Resource type (JSON:API `type`) | `check` | | Collection / records root | `checks` | | REST base | `/v1/checks` | | Entity class | `Check` | ## API operations | Operation | Method & path | Status | | --------- | ------------------------ | ------------- | | List | `GET /v1/checks` | โœ… Implemented | | Retrieve | `GET /v1/checks/{id}` | โœ… Implemented | | Create | `POST /v1/checks` | ๐ŸŸก Planned | | Update | `PATCH /v1/checks/{id}` | ๐ŸŸก Planned | | Delete | `DELETE /v1/checks/{id}` | ๐ŸŸก Planned | ## Data model ### Attributes | Field | Type | Required | Constraints | Allowed values | Description | | ------------- | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | check\_id | string, UUID, ๐Ÿ”’ system | โœ… Yes | unique; generated by gen\_random\_uuid() on INSERT | โ€” | Public immutable identifier for the check. Used in all API responses and external references. Never expose the internal pk. | | cmc7 | string | โšช No | max length 35; nullable | โ€” | CMC7 magnetic-ink character recognition line printed at the bottom of the cheque. Encodes: 7-digit check number, 12-digit bank/branch code, 11-digit account number, 2-digit check key. Format is bank-dependent; no application-level regex is enforced. | | check\_number | string | โšช No | max length 20; nullable | โ€” | Human-readable check number as printed on the instrument (the sequential identifier within a cheque book). Used as the sort proxy for the composite\_checks\_list composite. | | issue\_date | date (YYYY-MM-DD) | โšช No | nullable; stored as PostgreSQL date (no time component) | โ€” | The date the cheque was issued (written), as declared on the instrument. Distinct from any settlement or booking date on an associated transaction. | | created\_at | datetime, ๐Ÿ”’ system | โœ… Yes | set on INSERT via onCreate lifecycle hook; not nullable | โ€” | Timestamp of record creation in the Well database. Set automatically; not editable by callers. | | updated\_at | datetime, ๐Ÿ”’ system | โšช No | set on INSERT and on every UPDATE via onUpdate lifecycle hook; nullable (null until first update on legacy rows) | โ€” | Timestamp of the most recent mutation. Managed by MikroORM lifecycle hooks. | | deleted\_at | datetime | โšช No | nullable; null means record is active | โ€” | Soft-delete sentinel. When set, the record is logically deleted and must be excluded from all queries (WHERE deleted\_at IS NULL). Hasura select\_permissions enforce this gate automatically for the user role. | ### Relationships | Name | Type | Required | Description | | -------------- | ------------------------ | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | company | to-one (company) | No โ€” mutually exclusive with people; at most one of the two is set | The Company that holds or issued this cheque. Stored as company\_pk FK. Either company or people is set, never both โ€” the entity comment documents this constraint as a business rule enforced at the application layer. | | people | to-one (people) | No โ€” mutually exclusive with company; at most one of the two is set | The Person who holds or issued this cheque. Stored as people\_pk FK. Mutually exclusive with company at the business-rule level. | | workspace | to-one (workspace) | No (nullable FK) โ€” effectively required for any workspace-scoped use | The Workspace that owns this check record. Used by Hasura RLS to tenant-isolate query results via X-Hasura-Workspace-Id header. Stored as workspace\_pk FK. | | payment\_means | to-many (payment\_means) | No | The PaymentMeans rows that reference this cheque instrument via check\_pk FK. A single Check may be referenced by multiple payment means (e.g. if re-presented or recorded across multiple contexts). The inverse FK lives on payment\_means; checks.payment\_means is a Hasura array\_relationship only โ€” there is no @OneToMany decorator in the MikroORM entity. | ### System-computed * check\_id is generated by PostgreSQL gen\_random\_uuid() on INSERT and exposed as the public identifier; the internal auto-increment pk is never surfaced in API responses. * created\_at is set automatically by the MikroORM onCreate lifecycle hook on INSERT. * updated\_at is set by both onCreate and onUpdate lifecycle hooks, reflecting the timestamp of the most recent write. * deleted\_at is managed by application-layer soft-delete logic; Hasura select\_permissions for the user role enforce deleted\_at IS NULL at the query layer so soft-deleted checks are never returned to end users. * The company / people mutual-exclusion constraint (checkholder is either a Company OR a Person, not both) is a business-rule invariant documented in the entity source; no DB-level CHECK enforces it โ€” enforcement is at the service/application layer. * Workspace scoping is enforced by Hasura RLS: the user-role filter requires workspace.workspace\_id = X-Hasura-Workspace-Id (direct) or workspace.workspace.workspace\_id = X-Hasura-Workspace-Id (child workspace), with workspace\_group membership paths for consolidated-view contexts. * The composite\_checks\_list composite (used when Check appears as a relation on Company or People records pages) is defined in composites.yml and surfaces check\_id, check\_number, and issue\_date as source\_fields with display\_type: relation\_list and is editable. * On Company and People records roots the Check appears as a composite\_checks\_list array field sorted by checks\_aggregate.min.check\_number. * On the checks records root, company and people checkholder composites (company.composite\_logo\_name, people.composite\_avatar\_fullname) and workspace composites are defined in composites.yml, along with composite\_payment\_means\_list. ## Example ```json theme={null} { "data": { "type": "check", "id": "c3f4a2e1-8b7d-4c09-a5f6-1d2e3f4a5b6c", "attributes": { "check_id": "c3f4a2e1-8b7d-4c09-a5f6-1d2e3f4a5b6c", "cmc7": "7654321012345678901234567890123", "check_number": "000123", "issue_date": "2026-01-15", "created_at": "2026-01-15T09:30:00.000Z", "updated_at": "2026-01-15T09:30:00.000Z", "deleted_at": null }, "relationships": { "company": { "data": { "type": "company", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } }, "people": { "data": null }, "workspace": { "data": { "type": "workspace", "id": "w9x8y7z6-a5b4-c3d2-e1f0-g9h8i7j6k5l4" } }, "payment_means": { "data": [ { "type": "payment_means", "id": "pm-uuid-0001-0002-0003-000400050006" } ] } } } } ``` Source: `apps/api/src/database/entities/Check.ts` ยท domain: financial-graph ยท tier: Supporting