Working with Matters in Clio

Overview

The following operations allow you to work with matters. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with matters, see Sample configuration.

Operation	Description
createMatter	Creates a new matter (case matter for a contact).
getMatter	Retrieves a matter by ID.
listMatters	Retrieves all matters.

Operation details

This section provides further details on the operations related to matters.

Creating a new matter

The createMatter operation creates a new matter (case matter for a contact).

createMatter

<clio.createMatter>
	<displayNumber>{$ctx:displayNumber}</displayNumber>
    <clientId>{$ctx:clientId}</clientId>
    <status>{$ctx:status}</status>
    <description>{$ctx:description}</description>
    <clientReference>{$ctx:clientReference}</clientReference>
    <responsibleAttorney>{$ctx:responsibleAttorney}</responsibleAttorney>
    <originatingAttorney>{$ctx:originatingAttorney}</originatingAttorney>
    <practiceArea>{$ctx:practiceArea}</practiceArea>
    <location>{$ctx:location}</location>
    <pendingDate>{$ctx:pendingDate}</pendingDate>
    <openDate>{$ctx:openDate}</openDate>
    <closeDate>{$ctx:closeDate}</closeDate>
    <billable>{$ctx:billable}</billable>
    <customFieldValues>{$ctx:customFieldValues}</customFieldValues>
    <permission>{$ctx:permission}</permission>
    <billingMethod>{$ctx:billingMethod}</billingMethod>
    <activityRates>{$ctx:activityRates}</activityRates>
    <assignedLists>{$ctx:assignedLists}</assignedLists>
    <flatRateRate>{$ctx:flatRateRate}</flatRateRate>
    <flatRateActivityUser>{$ctx:flatRateActivityUser}</flatRateActivityUser>
    <flatRateActivityDescription>{$ctx:flatRateActivityDescription}</flatRateActivityDescription>
</clio.createMatter>

Properties

displayNumber: The matter reference and label. Depending on the account's manual_matter_numbering setting, this is either "read only" (generated) or "customizable".
clientId: The client of the matter.
status: The matter status: "Pending", "Open", or "Closed".
description: The detailed description of the matter.
clientReference: The client reference string for external uses.
responsibleAttorney: The user responsible for the matter.
originatingAttorney: The user who referred the matter.
practiceArea: The practice area for the matter.
location: The location of the matter.
pendingDate: The date on which the matter was set to "pending".
openDate: The date on which the matter was set to "open".
closeDate: The "date" on which the matter was set to "closed".
billable: Indicates whether this matter is billable.
customFieldValues: A polymorphic collection of custom field values set on this matter.
permission: The matter permission will be for everyone in a firm, a specific group or the current user; this is a polymorphic relationship to either the group or the user.
billingMethod: The billing method of this matter, either "flat" or "hourly".
activityRates: A collection of firm-wide and attorney specific rates for this matter.
assignedLists: A collection of task template lists that have been assigned for this matter.
flatRateRate: The flat rate fee. This is a required field if the flat rate is chosen.
flatRateActivityUser: The attorney who earns the flat-rate activity. If not given for creating a new matter, it defaults to the logged-in user. If not given for updating a matter, the user of the flat-rate activity remains the same.
flatRateActivityDescription: The flat rate activity description, if the flat rate is chosen, the activity description must be already assigned to flat_rate_activity_user.

Sample request

Following is a sample REST/JSON request that can be handled by the createMatter operation.

Sample Request for createMatter

{
    "activityRates": [],
    "accessToken": "dcLXVwl8BeAUL697Dltw1PJOCYQM7Scm2BXSFuOO",
    "clientId": "887956542",
    "status": "Pending",
    "location": "Colombo",
    "customFieldValues": [],
    "permission": "",
    "closeDate": "2015-03-12",
    "billingMethod": "hourly",
    "displayNumber": "000017-Virtusa A1 (Pvt) Ltd",
    "responsibleAttorney": "",
    "practiceArea": "",
    "flatRateActivityUser": "",
    "flatRateRate": "",
    "billable": "true",
    "assignedLists": [],
    "originatingAttorney": "",
    "clientReference": "",
    "description": "sample description",
    "flatRateActivityDescription": "",
    "apiUrl": "https://app.goclio.com",
    "pendingDate": "",
    "openDate": ""
}

Retrieving a matter by ID

The getMatter operation retrieves a matter by ID.

getMatter

<clio.getMatter>
	<matterId>{$ctx:matterId}</matterId>
</clio.getMatter>

Properties

matterId: The ID of the matter whose details should be retrieved.

Sample request

Following is a sample REST/JSON request that can be handled by the getMatter operation.

getMatter

{
    "matterId": "",
    "accessToken": "",
    "apiUrl": "https://app.goclio.com"
}

Retrieving all matters

The listMatters operation retrieves all matters.

listMatters

<clio.listMatters>
	<clientId>{$ctx:clientId}</clientId>
    <practiceAreaId>{$ctx:practiceAreaId}</practiceAreaId>
    <status>{$ctx:status}</status>
    <displayNumber>{$ctx:displayNumber}</displayNumber>
    <offset>{$ctx:offset}</offset>
    <limit>{$ctx:limit}</limit>
    <createdSince>{$ctx:createdSince}</createdSince>
    <updatedSince>{$ctx:updatedSince}</updatedSince>
</clio.listMatters>

Properties

clientId: Returns all matters belonging to the given client ID.
practiceAreaId: Returns all matters belonging to the given practice area ID.
status: Returns all matters with a given status; a status must be one of the following: "Open", "Closed" or "Pending".
displayNumber: The wildcard search for display_number matching of a given string.
offset: Returns records with an ID greater than the offset.
limit: The maximum number of records to be returned (int, default 1000).
createdSince: Returns records created on or after the date (date, ISO 8601 format).
updatedSince: Returns records updated on or after the date (date, ISO 8601 format).

Sample request

Following is a sample REST/JSON request that can be handled by the listMatters operation.

listMatters

{
    "limit": "",
    "createdSince": "",
    "practiceAreaId": "",
    "accessToken": "",
    "status": "",
    "apiUrl": "https://app.goclio.com",
    "updatedSince": "",
    "offset": "",
    "displayNumber": "",
    "clientId": ""
}

Sample configuration

Following is a sample proxy service that illustrates how to connect to Clio with the init operation and use the createMatter operation. The sample request for this proxy can be found in the createMatter sample request. You can use this sample as a template for using other operations in this category.

createMatter

<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="clio_createMatter"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="accessToken" expression="json-eval($.accessToken)"/>
         <property name="displayNumber" expression="json-eval($.displayNumber)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="status" expression="json-eval($.status)"/>
         <property name="description" expression="json-eval($.description)"/>
         <property name="clientReference" expression="json-eval($.clientReference)"/>
         <property name="responsibleAttorney"
                   expression="json-eval($.responsibleAttorney)"/>
         <property name="originatingAttorney"
                   expression="json-eval($.originatingAttorney)"/>
         <property name="practiceArea" expression="json-eval($.practiceArea)"/>
         <property name="location" expression="json-eval($.location)"/>
         <property name="pendingDate" expression="json-eval($.pendingDate)"/>
         <property name="openDate" expression="json-eval($.openDate)"/>
         <property name="closeDate" expression="json-eval($.closeDate)"/>
         <property name="billable" expression="json-eval($.billable)"/>
         <property name="customFieldValues" expression="json-eval($.customFieldValues)"/>
         <property name="permission" expression="json-eval($.permission)"/>
         <property name="billingMethod" expression="json-eval($.billingMethod)"/>
         <property name="activityRates" expression="json-eval($.activityRates)"/>
         <property name="assignedLists" expression="json-eval($.assignedLists)"/>
         <property name="flatRateRate" expression="json-eval($.flatRateRate)"/>
         <property name="flatRateActivityUser"
                   expression="json-eval($.flatRateActivityUser)"/>
         <property name="flatRateActivityDescription"
                   expression="json-eval($.flatRateActivityDescription)"/>
         <clio.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <accessToken>{$ctx:accessToken}</accessToken>
         </clio.init>
         <clio.createMatter>
            <displayNumber>{$ctx:displayNumber}</displayNumber>
            <clientId>{$ctx:clientId}</clientId>
            <status>{$ctx:status}</status>
            <description>{$ctx:description}</description>
            <clientReference>{$ctx:clientReference}</clientReference>
            <responsibleAttorney>{$ctx:responsibleAttorney}</responsibleAttorney>
            <originatingAttorney>{$ctx:originatingAttorney}</originatingAttorney>
            <practiceArea>{$ctx:practiceArea}</practiceArea>
            <location>{$ctx:location}</location>
            <pendingDate>{$ctx:pendingDate}</pendingDate>
            <openDate>{$ctx:openDate}</openDate>
            <closeDate>{$ctx:closeDate}</closeDate>
            <billable>{$ctx:billable}</billable>
            <customFieldValues>{$ctx:customFieldValues}</customFieldValues>
            <permission>{$ctx:permission}</permission>
            <billingMethod>{$ctx:billingMethod}</billingMethod>
            <activityRates>{$ctx:activityRates}</activityRates>
            <assignedLists>{$ctx:assignedLists}</assignedLists>
            <flatRateRate>{$ctx:flatRateRate}</flatRateRate>
            <flatRateActivityUser>{$ctx:flatRateActivityUser}</flatRateActivityUser>
            <flatRateActivityDescription>{$ctx:flatRateActivityDescription}</flatRateActivityDescription>
         </clio.createMatter>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>

WSO2 ESB Connectors Documentation

Working with Matters in Clio

Overview

Operation details

Creating a new matter

Properties

Sample request

Related Clio documentation

Retrieving a matter by ID

Properties

Sample request

Related Clio documentation

Retrieving all matters

Properties

Sample request

Related Clio documentation

Sample configuration