v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Matters

Get a matter

Retrieves a specified matter.

get/matters/{matterId}

Path parameters

matterIdstring uuid required

Response

When request is successful. Returns a 'Matter' object.

hrefstring nullable

relationstring nullable

methodstring nullable

idstring nullable

Unique identifier of the matter.

externalSystemIdstring nullable

External system id for the matter.

versionIdstring nullable

Version id of the record. This can be used in the UpdatedSince query parameter.

numberstring nullable

Human-friendly number assigned to matter.

titlestring nullable

Title of the matter.

descriptionstring nullable

Brief description of the matter.

statusstring nullable

Current status of the matter.

Possible values: Open, Pending, Closed, Deleted or Cancelled.

clientCodestring nullable

Associates an external client code to this matter.

Only supported in AU and UK.

openedDatestring date-time nullable

Date the matter was opened.

closedDatestring date-time nullable

Date the matter was closed.

leadOpenedDatestring date-time nullable

Date the lead was opened.

Only applies if isLead is true.

leadClosedDatestring date-time nullable

Date the lead was closed.

Only applies if isLead is true.

leadClosedReasonstring nullable

Reason the lead was closed.

Only applies if isLead is true.

isLeadboolean

Boolean flag indicating if the matter is a lead.

branchProviderIdstring nullable

Unique identifier of the associated branch provider.

referralTypestring nullable

The referral type of the matter.

referralAgreementFeeTypestring nullable

The referral agreement fee type.

referralAgreementFeenumber double nullable

The referral agreement fee value.

referralAgreementFeeCommentstring nullable

The referral agreement fee comment.

itemsobject nullable

Items associated with the matter.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "externalSystemId": "EXT01",
  "versionId": "637771038395217729",
  "number": "FUS-124",
  "title": "AM-0323-0005 - Smith - Sale - Jones",
  "description": "This is a brief description for the matter",
  "status": "Open",
  "clientCode": "Client A",
  "openedDate": "2022-04-23T14:00:00Z",
  "closedDate": "2022-04-23T14:00:00Z",
  "leadOpenedDate": "2022-04-23T14:00:00Z",
  "leadClosedDate": "2022-04-23T14:00:00Z",
  "leadClosedReason": "No longer interested",
  "branchProviderId": "Smokeball",
  "tags": [
    {
      "id": "a15086f5-4da7-4271-8fea-b24d479ced2b",
      "type": "Staff",
      "color": "Light Blue"
    }
  ]
}