Matter data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
number | string | No | the firm's display/matter number |
description | string | No | |
status | enum | No | Values: PENDING, OPEN, CLOSED, OTHER |
billing_method | enum | No | Values: HOURLY, FLAT_FEE, CONTINGENCY, OTHER |
practicearea_id | string | No | pointer to the Legal Practicearea object |
stage | string | No | the matter stage name |
contact_ids | string[] | No | CRM Contacts that are clients on this matter |
company_ids | string[] | No | CRM Companies that are clients on this matter |
parties | LegalParty[] | No | all people and organizations related to this matter, with their role |
parties[].contact_id | string | No | pointer to a CRM Contact |
parties[].company_id | string | No | pointer to a CRM Company |
parties[].role | enum | No | Values: CLIENT, OPPOSING_PARTY, OPPOSING_COUNSEL, CO_COUNSEL, WITNESS, EXPERT, JUDGE, REFERRER, OTHER |
parties[].description | string | No | the vendor's free-text relationship description |
user_id | string | No | HR Employee who is the responsible attorney (reference to HrisEmployee) |
originating_user_id | string | No | HR Employee who is the originating attorney (reference to HrisEmployee) |
user_ids | string[] | No | other HR Employees assigned to this matter |
client_reference | string | No | the client's own reference number for this matter |
currency | string | No | |
is_billable | boolean | No | |
opened_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
closed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
pending_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
statute_of_limitations_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metadata | LegalMetadata[] | No | custom field values |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know