Playground

Playground

Vendor

/api/v1/contracts/vendors

A vendor counterparty.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
namestringCanonical machine-friendly name for the vendor (e.g. 'acme-corp'). Used in API filters and cross-system references.
display_namestringHuman-readable display name shown in the UI and API responses.
websitestringPrimary website URL for this vendor. Null if unknown.
risk_ratingstringVendor risk rating assigned by the procurement or security team. Drives contract review cadence and access controls.
payment_terms_daysnumberStandard payment terms in days (e.g. 30 for net-30). Null if not yet negotiated.
account_manager_namestringFull name of the vendor's account manager for this enterprise.
account_manager_emailemailEmail address of the vendor's account manager.
strategic_tierstringProcurement tier classification. 'preferred' vendors receive priority sourcing; 'restricted' vendors require executive approval.
statusstringLifecycle status of the vendor relationship. 'under_review' triggers a compliance workflow.
notesstringFreeform notes about the vendor, visible only to internal users.
tagsjsonFlat string tags for grouping and filtering (e.g. 'cloud', 'saas', 'eu-gdpr').

API

client.contracts.vendors.*
Loading manifest…