LawVu Matters (1.0)

Apis for matter resources

Download OpenAPI description
LawVu Matters.openapi.json
LawVu Matters.openapi.yaml
Languages
Servers
https://demo.public-api.lawvu.com/matter-apis/

Matters

Operations

Create matter

Request

Creates a new matter with the supplied values

Body
namestring or null

Name of the matter

categoryIdinteger(int32)required

To retrieve categories ref: /mattercategories

organisationIdinteger or null(int32)

Leave null for default organisation

fieldsobject or null

To retrieve fields for matter creation ref: mattercategories/{categoryId}/createSchema Fields without grouping example serialization: "fields":{ "field_[fieldId]":null, "field_[fieldId]":false } Fields with grouping example serialization: "fields":{ "group_[groupId]": { "field_[fieldId]":null, "field_[fieldId]":false } }

restrictedboolean

Is the matter restricted

urgentboolean

Is the matter urgent

parentIdinteger or null(int32)
managerIdstring or null

Optionally set the Manager of the new Matter

ownerIdstring or null

Optionally set the Owner of the new Matter

externalIdstring or null

Optionally set an ID from an external system. Uniqueness is enforced for your organisation

teamIdinteger or null(int32)

Set the team assignment. This can be required [ref:MatterTemplate.TeamRequired]

{
  "name": "string",
  "categoryId": 0,
  "organisationId": 0,
  "fields": {},
  "restricted": true,
  "urgent": true,
  "parentId": 0,
  "managerId": "string",
  "ownerId": "string",
  "externalId": "string",
  "teamId": 0
}

Responses

Success

Body
integer(int32)
Response
null

Get matters

Request

Gets matters filtered by single or multiple fields.
To filter by one field: "filtering.field", "filtering.operator" and "filtering.value" parameters must be filled.
To filter by multiple fields: "filtering.logic" and "filtering.filters" parameters must be filled.

Query
skipinteger(int32)

Format - int32. The number of matters to skip (used for paging)

fieldsArray of strings or null

Fields to include in the response

filtering.logicstring or null

Gets or sets the filtering logic for filters. Value by default is 'and'

Options:

  • and
  • or

Enum"and""or"
filtering.filtersArray of objects(FilteringArray)

Array of filters object (optional)
Object Properties:

  • Field: field to filter by
  • Operator: operator used to filter by
  • Value: value to filter by
filtering.fieldstring or null

Field to filter by (optional)

filtering.operatorstring

Operator used for filtering (optional)

Options:

  • eq
  • neq
  • lt
  • lte
  • gt
  • gte
  • startswith
  • endswith
  • contains
  • doesnotcon
  • isnull

Enum"eq""neq""lt""lte""gt""gte""startswith""endswith""contains""doesnotcon"
filtering.valuestring or null

Value to filter by (optional)

sorting.directionstring

Set the sorting direction

Options:

  • asc
  • desc

Enum"asc""desc"
sorting.fieldstring or null

Set the sorting fields

takeinteger(int32)

Format - int32. The maximum number of matters to return

Default: 50

Default 50
contextstring

Controls the scope of matters returned by this operation

Default: Personal

Options:

  • All - Returns all matters regardless of whether the authenticated user is a member. Requires the authenticated user to be a member of the Matter Administrators security group
  • Personal - Returns matters which the authenticated user is a member of. Equivalent to the "My matters" view in LawVu
  • Intake - Returns all matters in the Intake queue. Requires the authenticated user to have the 'Manage intake' permission
  • Teams - Returns all matters that are accessible by teams that the authenticated user is a member of
  • Restricted - Returns restricted matters. Requires the authenticated user to be an Organization Administrator

Default "Personal"
Enum"All""Personal""Intake""Teams""Restricted"
No request payload

Responses

Success

Body
dataArray of objects or null

Represents a single page of processed data.

totalinteger(int32)

The total number of records available.

Response
null

Find matters

Request

Quickly find and filter matters

Query
termstring or null

A term to search matters by

includeRestrictedboolean

Include restricted matters in the search

Default: False

Default false
takeinteger or null(int32)

Format - int32. The number of matters to return (maximum: 100, default: 20)

No request payload

Responses

Success

Body
Array [
idinteger(int32)
matterNumberstring or null
namestring or null
organisationNamestring or null
referencestring or null
managerReferencestring or null
purchaseOrderNumberstring or null
parentIdinteger or null(int32)
organisationIdinteger(int32)
]
Response
null

Get matter

Request

Gets the details of the selected matter (ref: matterId)

Path
matterIdinteger(int32)required

Format - int32. The Id of the matter (e.g. 1234)

No request payload

Responses

Success

Body
idinteger(int32)
matterNumberstring or null
matterUrlstring or null
createdDateUtcstring(date-time)
managerOrganisationIdinteger or null(int32)
ownerobject(MatterUser)
managerobject(MatterUser)
organisationIdinteger(int32)
organisationNamestring or null
lastStatusMessageobject(StatusMessage)
termsobject(TermsAndConditions)
matterSpecificEmailstring or null
tagsArray of objects or null(MatterTagModel)
categoryIdinteger(int32)
externalIdstring or null
namestring or null
parentIdinteger or null(int32)
restrictedboolean
statusstring or null
teamIdinteger or null(int32)
urgentboolean
Response
null

Update matter

Request

Update matter

Path
matterIdinteger(int32)required

Format - int32. The Id of the matter

Body

The update request (in jsonpatch format)

Array [
valueobject or null
pathstring or null
opstring or null
fromstring or null
]
[
  {
    "value": {},
    "path": "string",
    "op": "string",
    "from": "string"
  }
]

Responses

Success

Recent matters

Request

Returns recently viewed (ref:take) matters for the user

Query
takeinteger(int32)

Format - int32. The maximum number of recently viewed matters to return

Default: 5

Default 5
No request payload

Responses

Success

Body
Array [
idinteger(int32)
namestring or null
matterNumberstring or null
lastActivityDateUtcstring or null(date-time)

The UTC date of when the current user last viewed the Matter

organisationIdinteger(int32)
managerIdstring or null
ownerIdstring or null
]
Response
[
  {
    "id": 95,
    "name": "My Matter",
    "matterNumber": "LV1234-0012",
    "lastActivityDateUtc": "2023-12-15T08:30:00.0000000+00:00",
    "organisationId": 1234,
    "managerId": "C7541186-26CE-4C6C-ABFF-37FE3EF57F88",
    "ownerId": "08FD1ED1-627E-4CB9-8388-731227584D21"
  },
  {
    "id": 789,
    "name": "Another Matter",
    "matterNumber": "LV1234-0099",
    "lastActivityDateUtc": "2024-01-12T10:00:00.0000000+00:00",
    "organisationId": 1234,
    "managerId": null,
    "ownerId": "BE17D7D6-721A-4F6D-B081-CAABB6D8F5B9"
  },
  {
    "id": 684,
    "name": "Different Matter",
    "matterNumber": "LV1234-0054",
    "lastActivityDateUtc": "2023-12-10T03:30:00.0000000+00:00",
    "organisationId": 1234,
    "managerId": "C7541186-26CE-4C6C-ABFF-37FE3EF57F88",
    "ownerId": "BE17D7D6-721A-4F6D-B081-CAABB6D8F5B9"
  }
]

Add user to a matter

Request

Adds a user to the matter (as owner, manager or regular matter member)

Path
matterIdinteger(int32)required

Format - int32. The Id of the matter

Body

Details about how to assign the user to the matter

userIdstringrequired

The ID of the user

targetstringrequired

The target of the assignment (Matter, MatterOwner or MatterManager)

Options:

  • Matter
  • MatterOwner
  • MatterManager

Enum"Matter""MatterOwner""MatterManager"
notestring or null

An optional note

{
  "userId": "string",
  "target": "Matter",
  "note": "string"
}

Responses

Success

Get matter users

Request

Returns the users that are assigned to the matter

Path
matterIdinteger(int32)required

Format - int32. The matter id

Query
skipinteger(int32)

Format - int32. The number of results to skip

filtering.fieldstring or null

Field to filter by (optional)

filtering.operatorstring

Operator used for filtering (optional)

Options:

  • eq
  • neq
  • lt
  • lte
  • gt
  • gte
  • startswith
  • endswith
  • contains
  • doesnotcon
  • isnull

Enum"eq""neq""lt""lte""gt""gte""startswith""endswith""contains""doesnotcon"
filtering.valuestring or null

Value to filter by (optional)

sorting.directionstring

Set the sorting direction

Options:

  • asc
  • desc

Enum"asc""desc"
sorting.fieldstring or null

Set the sorting fields

takeinteger(int32)

Format - int32. The maximum number of matter users to return

Default: 50

Default 50
No request payload

Responses

Success

Body
dataArray of objects or null(MatterUser)

Represents a single page of processed data.

totalinteger(int32)

The total number of records available.

Response
null

ExternalId lookup

Request

ExternalId lookup

Path
externalIdstring or nullrequired

The externalId to lookup

No request payload

Responses

Success

Body
idinteger(int32)
Response
null

Get matter fields

Request

Get matter fields by matter id

Path
matterIdinteger(int32)required

Format - int32. The Id of the matter

No request payload

Responses

Success

Body
detailFieldsobject(FieldData)
coreFieldsobject(FieldData)
Response
{
  "detailFields": {
    "schema": {
      "properties": {
        "field_1": {
          "fieldId": 1,
          "title": "An example field name",
          "description": "Example field description",
          "lawvuType": 7,
          "isReadOnly": false,
          "type": "boolean",
          "label": ""
        }
      },
      "order": [
        "field_1"
      ],
      "required": [
        "field_1"
      ]
    },
    "model": {
      "field_1": true
    }
  },
  "coreFields": {
    "schema": null,
    "model": null
  }
}

Update fields

Request

Update fields

Path
matterIdinteger(int32)required

Format - int32. The Id of the matter

Body

The update request (in jsonpatch format)

Array [
valueobject or null
pathstring or null
opstring or null
fromstring or null
]
{
  "value": "new value",
  "path": "/field_string",
  "op": "replace"
}

Responses

Success

MatterCategories

Operations

MatterFiles

Operations

MattersInvoices

Operations

MatterStatusMessage

Operations

MatterTaskTemplates

Operations

MatterTasks

Operations