Get a list of matters
query Parameters
querystringSearch for matters matching the query string. Returns matters that match partially on either name or reference, or match client name or reference.
referencestringReturn matter matching the matter reference (exact match only)
clientReferencestringReturn matters matching the client reference (exact match only)
userIdstring · uuidOnly return matters where this user is assigned
responsibleIdstring · uuidOnly return matters where this user is responsible
originatorIdstring · uuidOnly return matters where this user is the originator
clientIdstring · uuidFilter by client, only return matters for this client
practiceAreaIdstring · uuidFilter by practice area, only return matters for this practice area
archivedbooleanFilter by archived- return only archived matters (true) or only active matters (false) or all matters (null)
selectstringUsed to include additional detail in the response with a comma separated list of object identifiers. Fields can be prefixed with a minus sign to exclude them. Supported fields: client, ledesConfiguration, responsible, originator, practiceArea, meta, customFields
sortstringSorting parameters for matters. Supported sort fields: name, reference, client.name, client.reference Example: "name,-client.name" sorts by name ascending, then client name descending
limitinteger · int32 · min: 1 · max: 1000Maximum number of items to return (default: 1000, max: 1000)
offsetinteger · int32 · min: 0 · max: 2147483647Number of items to offset (default: 0)
modifiedSincestring · date-timeOnly return results that have the ModifiedDate property after this date and time (optional)
Responses
OK
dataarray | nullThe list of items returned by the API
paginationobjectPagination information
Create a new matter
If the firm has the QuickBooks Online integration enabled, creating a matter also creates the corresponding customers in QuickBooks. A client that is not yet connected to QuickBooks is created there as a customer, provided the firm is set up to let LeanLaw create its accounting clients, and the matter is created as a sub-customer of that client when the firm bills per matter. A firm that bills at the client level gets the client customer only, and no sub-customer for the matter. Note that creating a client on its own does not reach QuickBooks — the client is created there as part of creating its first matter.
QuickBooks is never allowed to fail the request: if it is unavailable or rejects the customer, the matter is still created and returned as usual, and it can be connected from the LeanLaw app later.
Request Body
namestring · minLength: 1 · requiredThe name of the matter
clientIdstring · uuid · requiredThe client id of the matter (required)
responsibleIdstring · uuid · requiredUser id for responsible attorney for matter
referencestring | nullA reference number for the matter (optional)
matterTypestring · enumMatter type determines defaults for time entries and certain billing behaviors. The default value is "hourly".
Enum values:hourlyfixedFeecontingencyprobonointernaloriginatorIdstring | null · uuidUser id for originating attorney for matter (optional)
openedstring | null · dateThe date the matter was opened
archivedbooleanWhether the matter is archived (true) or active (false)
conflictInformationobjectConflict information for a matter
billingInstructionsstring | nullBilling instructions for the matter
notesstring | nullNotes about the matter
referralSourcesstring | nullReferral sources for the matter
practiceAreaIdstring | null · uuidThe practice area id for the matter (optional)
rateGroupIdstring | null · uuidRate group ID for the matter (optional)
customFieldsarray | nullInitial values for the matter's custom fields. Optional - any custom field not listed is left unset. Ids come from GET /v2/custom-fields?entity=matter.
Responses
OK
dataobjectRepresents a matter in the firm
Update a matter
The update is "sparse", where only the fields that are provided in the request will be updated.
path Parameters
idstring · uuid · requiredThe id of the matter to update
Request Body
namestring | nullThe name of the matter, if not provided, the current name will not be changed
referencestring | nullA reference number for the matter; if not provided, the current reference will not be changed
clientIdstring | null · uuidThe client id of the matter - if not provided, the client will not be changed
responsibleIdstring | null · uuidUser id for responsible attorney for matter, if not provided, the current responsible will not be changed
openedstring | null · dateThe date the matter was opened, if not provided, the current opened date will not be changed
archivedboolean | nullWhether the matter is archived (true) or active (false), if not provided, the current archived state will not be changed
conflictInformationobjectConflict information for a matter
billingInstructionsstring | nullBilling instructions for the matter, if not provided, the current billing instructions will not be changed
notesstring | nullNotes about the matter, if not provided, the current notes will not be changed
referralSourcesstring | nullReferral sources for the matter, if not provided, the current referral sources will not be changed
practiceAreaIdstring | null · uuidPractice area id for the matter, if not provided, the current practice area will not be changed. To unassign the matter from a practice area, set this field to an empty guid (00000000-0000-0000-0000-000000000000)
customFieldsarray | nullCustom field values to set. Only the fields listed are changed - omit the property entirely to leave every custom field alone, and set an entry's value to null to clear that one field.
Responses
OK
dataobjectRepresents a matter in the firm
Delete a matter
Deleting a matter will remove it from the system permanently. Matters that have
any associated activity in the system such as time entries, expenses, or invoices
cannot be deleted. To archive a matter, use UpdateMatter and set the Archived property to true.
path Parameters
idstring · uuid · requiredThe id of the matter to delete
Responses
OK