LawVu Matters (1.0)

Download OpenAPI specification:Download

Apis for matter resources

Matters

Create matter

Creates a new matter with the supplied values

Request
Request Body schema:
name
string or null

Name of the matter

categoryId
required
integer <int32>

To retrieve categories ref: /mattercategories

organisationId
integer or null <int32>

Leave null for default organisation

fields
object 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 } }

restricted
boolean

Is the matter restricted

urgent
boolean

Is the matter urgent

parentId
integer or null <int32>
managerId
string or null

Optionally set the Manager of the new Matter

ownerId
string or null

Optionally set the Owner of the new Matter

externalId
string or null

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

teamId
integer or null <int32>

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

Responses
200

Success

post/v1/matters
Request samples
{
  • "name": "string",
  • "categoryId": 0,
  • "organisationId": 0,
  • "fields": { },
  • "restricted": true,
  • "urgent": true,
  • "parentId": 0,
  • "managerId": "string",
  • "ownerId": "string",
  • "externalId": "string",
  • "teamId": 0
}
Response samples 
null

Get matters

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.

Request
query Parameters
skip
integer <int32>

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

fields
Array of strings or null

Fields to include in the response

filtering.logic
string or null

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

Options:

  • and
  • or

Enum: "and" "or"
Array 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.field
string or null

Field to filter by (optional)

filtering.operator
string

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" "isnull"
filtering.value
string or null

Value to filter by (optional)

sorting.direction
string

Set the sorting direction

Options:

  • asc
  • desc

Enum: "asc" "desc"
sorting.field
string or null

Set the sorting fields

take
integer <int32>
Default: 50

Format - int32. The maximum number of matters to return

Default: 50

context
string
Default: "Personal"

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

Enum: "All" "Personal" "Intake" "Teams" "Restricted"
Responses
200

Success

get/v1/matters
Response samples 
null

Find matters

Quickly find and filter matters

Request
query Parameters
term
string or null

A term to search matters by

includeRestricted
boolean
Default: false

Include restricted matters in the search

Default: False

take
integer or null <int32>

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

Responses
200

Success

get/v1/matters/quickfind
Response samples 
null

Get matter

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

Request
path Parameters
matterId
required
integer <int32>

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

Responses
200

Success

get/v1/matters/{matterId}
Response samples 
null

Update matter

Update matter

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The Id of the matter

Request Body schema:

The update request (in jsonpatch format)

Array
value
object or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

patch/v1/matters/{matterId}
Request samples
[
  • {
    }
]

Recent matters

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

Request
query Parameters
take
integer <int32>
Default: 5

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

Default: 5

Responses
200

Success

get/v1/matters/recent
Response samples 
[
  {
    "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

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

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The Id of the matter

Request Body schema:

Details about how to assign the user to the matter

userId
required
string

The ID of the user

target
required
string

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

Options:

  • Matter
  • MatterOwner
  • MatterManager

Enum: "Matter" "MatterOwner" "MatterManager"
note
string or null

An optional note

Responses
200

Success

post/v1/matters/{matterId}/users
Request samples
{
  • "userId": "string",
  • "target": "Matter",
  • "note": "string"
}

Get matter users

Returns the users that are assigned to the matter

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The matter id

query Parameters
skip
integer <int32>

Format - int32. The number of results to skip

filtering.field
string or null

Field to filter by (optional)

filtering.operator
string

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" "isnull"
filtering.value
string or null

Value to filter by (optional)

sorting.direction
string

Set the sorting direction

Options:

  • asc
  • desc

Enum: "asc" "desc"
sorting.field
string or null

Set the sorting fields

take
integer <int32>
Default: 50

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

Default: 50

Responses
200

Success

get/v1/matters/{matterId}/users
Response samples 
null

ExternalId lookup

ExternalId lookup

Request
path Parameters
externalId
required
string or null

The externalId to lookup

Responses
200

Success

get/v1/matters/externalid/{externalId}
Response samples 
null

Get matter fields

Get matter fields by matter id

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The Id of the matter

Responses
200

Success

get/v1/matters/{matterId}/fields
Response samples 
{
  "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

Update fields

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The Id of the matter

Request Body schema:

The update request (in jsonpatch format)

Array
value
object or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

patch/v1/matters/{matterId}/fields
Request samples
{
  • "value": "new value",
  • "path": "/field_string",
  • "op": "replace"
}

MatterCategories

Matter categories

Gets the configured categories for a matter

Responses
200

Success

get/v1/mattercategories
Response samples
No sample

Matter creation schema

Get the form and fields for rendering a create matter form

Request
path Parameters
categoryId
required
integer <int32>

Format - int32. The category to get the create form for

Responses
200

Success

get/v1/mattercategories/{categoryId}/createSchema

MatterFiles

Upload file

Add or update a file in a matter.

The body of the request must be content-type 'multipart/form-data' and contain the file data.

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The id of the matter

query Parameters
comments
string or null

Comments to be added to the file

parentFileId
integer or null <int32>

Format - int32. Creates a new version for the specified parent file id

folderId
integer or null <int32>

Format - int32. The id of the folder to upload the file within

conflictResolution
string or null

Defines behaviour for when a file conflict is found

Options:

  • Replace
  • KeepBoth
  • SaveVersion
  • Skip

Enum: "Replace" "KeepBoth" "SaveVersion" "Skip"
Request Body schema: multipart/form-data
file
string
Responses
201

The id of the created file

204

When the file was skipped due to conflict resolution setting

post/v1/matters/{matterId}/files
Response samples 
null

MattersInvoices

Get matter invoices

Get matter invoices

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The Id of the matter

query Parameters
skip
integer <int32>

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

filtering.field
string or null

Field to filter by (optional)

filtering.operator
string

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" "isnull"
filtering.value
string or null

Value to filter by (optional)

sorting.direction
string

Set the sorting direction

Options:

  • asc
  • desc

Enum: "asc" "desc"
sorting.field
string or null

Set the sorting fields

take
integer <int32>
Default: 50

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

Default: 50

Responses
200

Success

get/v1/matters/{matterId}/invoices
Response samples 
null

MatterStatusMessage

Add a status message to a matter

Adds a status message to a matter

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The Id of the matter

Request Body schema:

The status message to add

statusMessage
required
string
Responses
204

Success

post/v1/matters/{matterId}/statusMessages
Request samples
{
  • "StatusMessage": "Test status message"
}

MatterTaskTemplates

Get task templates

Gets task templates

Responses
200

Success

get/v1/matters/tasktemplates
Response samples 
[
  {
    "id": 1,
    "name": "name task template 1",
    "description": "description task template 1",
    "createdDateUtc": "2024-02-22T07:47:21.0000000+00:00"
  },
  {
    "id": 2,
    "name": "name task template 2",
    "description": "description task template 2",
    "createdDateUtc": "2024-02-22T07:47:21.0000000+00:00"
  }
]

Add a task template to matter

Adds a task template to a matter

Request
path Parameters
matterId
required
integer <int32>

Format - int32. The ID of the matter

Request Body schema:

The ID of the task template

templateId
required
integer <int32>
Responses
204

Success

post/v1/matters/{matterId}/taskTemplates
Request samples
{
  • "templateId": 1
}

MatterTasks

Get tasks

Get tasks

Request
query Parameters
skip
integer <int32>

Format - int32. Number of tasks to skip (used for paging)

filtering.field
string or null

Field to filter by (optional)

filtering.operator
string

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" "isnull"
filtering.value
string or null

Value to filter by (optional)

sorting.direction
string

Set the sorting direction

Options:

  • asc
  • desc

Enum: "asc" "desc"
sorting.field
string or null

Set the sorting fields

take
integer <int32>
Default: 50

Format - int32. The maximum number of tasks to return

Default: 50

Responses
200

Success

get/v1/matters/tasks
Response samples 
null