LeanLaw API

Schemas

BillingType

string · enum

Enum values:

nonBillable

billable

fixedFee

ClientBalances

balancenumber · double · required
Current account balance- includes all open final invoices
overduenumber · double · required
Total balances of all overdue invoices
overdue30number · double · required
Total balances of all invoices that are overdue more than 30 days
overdue60number · double · required
Total balances of all invoices that are overdue more than 60 days
overdue90number · double · required
Total balances of all invoices that are overdue more than 90 days

ClientBalancesResponse

dataobject
Financial summary of the client

ClientDetail

clientIdstring · uuid · required
The unique id of the client
namestring · minLength: 1 · required
The name of the client - either company name or individual name
contactobject · required

referencestring | null
A reference number for the client
notesstring | null
Internal notes about the client
metaobject

ClientDetailResponse

dataobject
A client of the firm with contact information and other detail
Example: {"id":"f7335cff-78fe-411b-adc7-c6a07b8fbdef","name":"Doe, John","contact":{"firstName":"John","lastName":"Doe","email":"[email protected]"}}

ClientList

clientIdstring · uuid · required
The unique id of the client
namestring · minLength: 1 · required
The name of the client - either company name or individual name

referencestring | null
A reference number for the client
contactobject
metaobject

ClientListListResponse

dataarray | null
The list of items returned by the API
paginationobject
Pagination information

ClientReference

namestring · minLength: 1 · required
The name of the Client - either company name or individual name

referencestring | null
A reference number for the Client

CodeDetail

codestring · minLength: 1 · required
The LEDES identifier for the code
labelstring · minLength: 1 · required
The label of the code
codeSetIdstring · minLength: 1 · required
Id of code set this code belongs to

parentCodestring | null
The parent code, if this code has a parent
selectableboolean
This code is selectable by the user. If this is false, the code is not valid for assigning to billable items but can still be shown to the user for informational purposes.

CodeList

activityobject[] · required
The list of activity codes
taskobject[] · required
The list of activity codes
expenseobject[] · required
The list of activity codes
codeSetsobject[] · required
List of code sets

CodeListResponse

dataobject
Represents the complete list of LEDES code sets

CodeSet

codeSetIdstring · minLength: 1 · required
The unique identifier of the code set
labelstring · minLength: 1 · required
The label/name of the code set
descriptionstring · minLength: 1 · required
The description of the code set

ConflictInformation

adversestring | null
Adverse party information
relatedAdversestring | null
Related adverse party information
relatedClientstring | null
Related client information
opposingstring | null
Opposing party information

Contact

companyNamestring | null
The company name if the client is a company.
firstNamestring | null
The first name of the client if an individual, or the billing contact in the company
lastNamestring | null
The last name of the client if an individual, or the billing contact in the company
middleNamestring | null
The middle name of the client if an individual, or the billing contact in the company
suffixstring | null
The suffix of the client name (Jr., Sr., III, etc.)
emailstring | null
The email of the client or billing contact
emailCCstring | null
The CC email address for the client or billing contact
phonestring | null
The primary phone number of client or billing contact
cellPhonestring | null
The cell phone number of client or billing contact
otherPhonestring | null
Additional phone number of client or billing contact
faxstring | null
The fax number of client or billing contact
streetstring | null
The street address of client or billing contact. Can have multiple lines.
citystring | null
The city of client or billing contact
statestring | null
The state or province of client or billing contact
zipstring | null
The ZIP or postal code of client or billing contact
countrystring | null
The country of client or billing contact

CreateClient

namestring · minLength: 1 · required
The name of the client

referencestring | null
A reference number for the client
contactobject
notesstring | null
Notes about the client

CreateExpense

matterIdstring · uuid · required
The matter is required.
datestring · date · required
The date of the expense. Required
descriptionstring · minLength: 1 · required
The description of the expense. Required
amountnumber · double · required
The amount of the expense (Required)

userIdstring | null · uuid
The user associated with the expense. If ommitted, the expense with associated with the firm
expenseCodestring | null
LEDES activity code

CreateFixedFee

matterIdstring · uuid · required
The matter is required.
datestring · date · required
The date of the fixed fee. Required
descriptionstring · minLength: 1 · required
The description of the fixed fee. Required
amountnumber · double · required
The amount of the fixed fee (Required)

userIdstring | null · uuid
The user associated with the fixed fee. If ommitted, the fixed fee with associated with the firm
activityCodestring | null
LEDES activity code
taskCodestring | null
LEDES task code

CreateMatter

namestring · minLength: 1 · required
The name of the matter
clientIdstring · uuid · required
The client id of the matter (required)
responsibleIdstring · uuid · required
User id for responsible attorney for matter

referencestring | null
A reference number for the matter (optional)
matterTypestring · enum
Matter type determines defaults for time entries and certain billing behaviors. The default value is "hourly".
Enum values:
hourly
fixedFee
contingency
probono
internal
openedstring | null · date
The date the matter was opened
archivedboolean
Whether the matter is archived (true) or active (false)
conflictInformationobject
Conflict information for a matter
billingInstructionsstring | null
Billing instructions for the matter
notesstring | null
Notes about the matter
referralSourcesstring | null
Referral sources for the matter

CreateTimeEntry

matterIdstring · uuid · required
The matter is required.
datestring · date · required
The date of the time entry. Required
descriptionstring · minLength: 1 · required
The description of the time entry. Required
hoursnumber · double · required
The number of hours for the time entry. Required

userIdstring · uuid
The user who created the time entry. This is required unless the userId is provided in the request header.
ratenumber | null · double
The rate of the time entry. If not provided, the rate for the user will be used. In most scenarios the rate should not be provided directly here.
billingTypestring · enum
Enum values:
nonBillable
billable
fixedFee
activityCodestring | null
LEDES activity code
taskCodestring | null
LEDES task code

ExpenseDetail

matterIdstring · uuid · required
The id of the matter that the expense is associated with.
matterobject · required
clientIdstring · uuid · required
The client that the expense is associated with.
clientobject · required
datestring · date · required
The date of the expense.
descriptionstring · minLength: 1 · required
The description of the expense.
billedboolean · required
Whether expense was billed or still waiting to be billed
amountnumber · double · required
The amount of the expense.

expenseIdstring · uuid
userIdstring | null · uuid
The id of the user who is assigned to the expense (If null, the expense is associated with the firm).
userobject
A user in the firm
expenseCodestring | null
LEDES expense code
metaobject

ExpenseDetailResponse

dataobject

ExpenseList

expenseIdstring · uuid · required
matterIdstring · uuid · required
The matter that the expense is associated with.
clientIdstring · uuid · required
The client that the expense is associated with.
datestring · date · required
The date of the expense.
descriptionstring · minLength: 1 · required
The description of the expense.
amountnumber · double · required
The amount of the expense.
billedboolean · required
Whether expense was billed or still waiting to be billed

userIdstring | null · uuid
The user who created the expense. If empty/null, the user is unassigned.
userobject
A user in the firm
matterobject
clientobject
metaobject

ExpenseListListResponse

dataarray | null
The list of items returned by the API
paginationobject
Pagination information

FixedFeeDetail

fixedFeeIdstring · uuid · required
matterIdstring · uuid · required
The id of the matter that the fixed fee is associated with.
matterobject · required
clientIdstring · uuid · required
The id of the client that the fixed fee is associated with.
clientobject · required
datestring · date · required
The date of the fixed fee.
descriptionstring · minLength: 1 · required
The description of the fixed fee.
amountnumber · double · required
The amount of the fixed fee.
billedboolean · required
Whether fixed fee was billed or still waiting to be billed

userIdstring | null · uuid
The id of the user assigned to the fixed fee.
userobject
A user in the firm
activityCodestring | null
LEDES activity code
taskCodestring | null
LEDES task code
metaobject

FixedFeeDetailResponse

dataobject

FixedFeeList

fixedFeeIdstring · uuid · required
The id of of the fixed fee
matterIdstring · uuid · required
The id of the matter that the fixed fee is associated with.
clientIdstring · uuid · required
The id of the client that the fixed fee is associated with.
datestring · date · required
The date of the fixed fee.
descriptionstring · minLength: 1 · required
The description of the fixed fee.
amountnumber · double · required
The amount of the fixed fee.
billedboolean · required
Whether fixed fee was billed or still waiting to be billed

userIdstring | null · uuid
The id of the user assigned to the fixed fee. If null, the fixed fee is unassigned.
userobject
A user in the firm
matterobject
clientobject
metaobject

FixedFeeListListResponse

dataarray | null
The list of items returned by the API
paginationobject
Pagination information

InvoiceList

invoiceIdstring · uuid · required
The id of the invoice.
clientIdstring · uuid · required
The id of the client associated with the invoice.
matterIdstring · uuid · required
The id of the matter associated with the invoice. Optional because some invoices may be associated with multiple matters.
datestring · date · required
The date of the invoice.
amountnumber · double · required
The total amount of the invoice.
balancenumber · double · required
The outstanding balance of the invoice.
invoiceNumberstring · minLength: 1 · required
The invoice number.
invoiceStatestring · enum · required
The state of an invoice
Enum values:
draft
review
approved
final

clientobject
matterobject
dueDatestring | null · date
The due date of the invoice. Only final invoices will have a due date.
metaobject

InvoiceListListResponse

dataarray | null
The list of items returned by the API
paginationobject
Pagination information

InvoiceState

string · enum

Enum values:

draft

review

approved

final

The state of an invoice

MatterDetail

matterIdstring · uuid · required
The unique identifier of the matter
namestring · minLength: 1 · required
The name of the matter - either company name or individual name
clientIdstring · uuid · required
The unique identifier of the client
matterTypestring · enum · required
Matter type determines defaults for time entries and certain billing behaviors. The default value is "hourly".
Enum values:
hourly
fixedFee
contingency
probono
internal
clientobject · required
Represents a summary of a client for a matter
responsibleIdstring · uuid · required
User id for responsible attorney for matter
responsibleobject · required
A user in the firm
archivedboolean · required
Whether the matter is archived (true) or active (false)

referencestring | null
A reference number for the matter
originatorIdsarray | null
List of user ids for originating attorneys for matter
originatorsarray | null
List of users that are originating attorneys for matter
practiceAreaIdstring | null · uuid
The practice area id of the matter
practiceAreaobject
Represents a practice area
openedstring | null · date
The date the matter was opened
conflictInformationobject
Conflict information for a matter
billingInstructionsstring | null
Billing instructions for the matter
notesstring | null
Notes about the matter
referralSourcesstring | null
Referral sources for the matter
ledesConfigurationobject
Configuration for LEDES in a matter
metaobject

MatterDetailClient

namestring · minLength: 1 · required
The name of the client - either company name or individual name

referencestring | null
A reference number for the client

MatterDetailResponse

dataobject
Represents a matter in the firm

MatterLedesConfiguration

enabledboolean · required
Whether LEDES billing is enabled for the matter
activityCodeRequiredboolean · required
Whether LEDES activity codes are required for time entries and fixed fees on the matter
taskCodeRequiredboolean · required
Whether LEDES task codes are required for time entries and fixed fees on the matter
expenseCodeRequiredboolean · required
Whether LEDES expense codes are required for expenses on the matter
codeSetIdsstring[] · required
CodeSets available for the matter

MatterList

matterIdstring · uuid · required
The unique identifier of the matter
namestring · minLength: 1 · required
The name of the matter
matterTypestring · enum · required
Matter type determines defaults for time entries and certain billing behaviors. The default value is "hourly".
Enum values:
hourly
fixedFee
contingency
probono
internal
archivedboolean · required
Whether the matter is archived (true) or active (false)
clientIdstring · uuid · required
The client id of the matter
responsibleIdstring · uuid · required
User id for responsible attorney for matter
originatorIdsstring[] · required
List of user ids for originating attorneys for matter

referencestring | null
A reference number for the matter
openedstring | null · date
The date the matter was opened
clientobject
Represents a summary of a client for a matter
responsibleobject
A user in the firm
originatorsarray | null
User details for originating attorneys for matter
practiceAreaIdstring | null · uuid
The practice area id of the matter
practiceAreaobject
Represents a practice area
ledesConfigurationobject
Configuration for LEDES in a matter
metaobject

MatterListClient

namestring · minLength: 1 · required
The name of the client - either company name or individual name

referencestring | null
A reference number for the client

MatterListListResponse

dataarray | null
The list of items returned by the API
paginationobject
Pagination information

MatterReference

namestring · minLength: 1 · required
The name of the matter - either company name or individual name

referencestring | null
A reference number for the matter

MatterType

string · enum

Enum values:

hourly

fixedFee

contingency

probono

internal

Matter type determines defaults for time entries and certain billing behaviors. The default value is "hourly".

Metadata

createdAtstring · date-time · required
The date the entity was created.
modifiedAtstring · date-time · required
The date the entity was last modified.

Pagination

limitinteger · int32 · required
Maximum number of items to return
offsetinteger · int32 · required
Number of items to offset
totalinteger · int32 · required
Total number of items available

sortstring | null
Current sort parameters applied to the results

PracticeAreaList

practiceAreaIdstring · uuid · required
The unique identifier of the practice area
labelstring · minLength: 1 · required
The label/name of the practice area
defaultboolean · required
Indicates whether this is the default practice area

PracticeAreaListIEnumerableResponse

dataarray | null
The data returned by the API

PracticeAreaReference

labelstring · minLength: 1 · required
The label/name of the practice area

Role

string · enum

Enum values:

principal

attorney

paralegal

timekeeper

operator

accountant

The role of the user

TimeEntryDetail

timeEntryIdstring · uuid · required
The id of the time entry.
userIdstring · uuid · required
The id of the user who created the time entry.
userobject · required
A user in the firm
matterIdstring · uuid · required
The matter id that the time entry is associated with.
matterobject · required
clientIdstring · uuid · required
The client id that the time entry is associated with.
clientobject · required
datestring · date · required
The date of the time entry. This date is used for billing.
descriptionstring · minLength: 1 · required
The description of the time entry.
hoursnumber · double · required
The number of hours for the time entry.
billingTypestring · enum · required
Enum values:
nonBillable
billable
fixedFee
billedboolean · required
Whether time entry was billed or still waiting to be billed

startTimestring | null · date-time
The date and time of the time entry. This will be returned as UTC time. Time entries might not have a starttime, only a date.
ratenumber | null · double
The rate of the time entry. Only provided for billable time entries (where billingType = "billable"). Requires "read.rates" scope or it will be omitted.
activityCodestring | null
LEDES activity code
taskCodestring | null
LEDES task code
metaobject

TimeEntryDetailResponse

dataobject

TimeEntryList

timeEntryIdstring · uuid · required
The id of the time entry.
userIdstring · uuid · required
The id of the user who created the time entry.
matterIdstring · uuid · required
The matter id that the time entry is associated with.
clientIdstring · uuid · required
The client id that the time entry is associated with.
datestring · date · required
The date of the time entry.
descriptionstring · minLength: 1 · required
The description of the time entry.
hoursnumber · double · required
The number of hours for the time entry.
billingTypestring · enum · required
Enum values:
nonBillable
billable
fixedFee
billedboolean · required
Whether time entry was billed or still waiting to be billed

userobject
A user in the firm
matterobject
clientobject
startTimestring | null · date-time
The date and time of the time entry. This will be returned as UTC time. Time entries might not have a starttime, only a date.
ratenumber | null · double
The rate of the time entry. Only provided for billable time entries (where billingType = "billable"). Requires "read.rates" scope or it will be omitted.
activityCodestring | null
LEDES activity code
taskCodestring | null
LEDES task code
metaobject

TimeEntryListListResponse

dataarray | null
The list of items returned by the API
paginationobject
Pagination information

UpdateClient

namestring | null
The name of the client, if not provided, the current name will not be changed
referencestring | null
A reference number for the client, if not provided, the current reference will not be changed
contactobject
notesstring | null
Notes about the client, if not provided, the current notes will not be changed

UpdateExpense

matterIdstring | null · uuid
Update the matter of the expense.
userIdstring | null · uuid
Update the user of the expense.
datestring | null · date
Update the date of the expense
descriptionstring | null
Update the description of the expense, provide null to keep the current description
amountnumber | null · double
Update the amount of the expense, provide null to keep the current amount
expenseCodestring | null
LEDES expense code

UpdateFixedFee

datestring | null · date
The date of the fixed fee.
matterIdstring | null · uuid
The matter that the fixed fee is associated with.
userIdstring | null · uuid
The user that the fixed fee is associated with.
descriptionstring | null
The description of the fixed fee.
amountnumber | null · double
The amount of the fixed fee
activityCodestring | null
LEDES activity code
taskCodestring | null
LEDES task code

UpdateMatter

namestring | null
The name of the matter, if not provided, the current name will not be changed
referencestring | null
A reference number for the matter; if not provided, the current reference will not be changed
clientIdstring | null · uuid
The client id of the matter - if not provided, the client will not be changed
responsibleIdstring | null · uuid
User id for responsible attorney for matter, if not provided, the current responsible will not be changed
openedstring | null · date
The date the matter was opened, if not provided, the current opened date will not be changed
archivedboolean | null
Whether the matter is archived (true) or active (false), if not provided, the current archived state will not be changed
conflictInformationobject
Conflict information for a matter
billingInstructionsstring | null
Billing instructions for the matter, if not provided, the current billing instructions will not be changed
notesstring | null
Notes about the matter, if not provided, the current notes will not be changed
referralSourcesstring | null
Referral sources for the matter, if not provided, the current referral sources will not be changed

UpdateTimeEntry

userIdstring | null · uuid
Update the user of the time entry.
matterIdstring | null · uuid
Update the matter of the time entry.
datestring | null · date
Update the date of the time entry
descriptionstring | null
Update the description of the time entry, provide null to keep the current description
hoursnumber | null · double
Update the hours of the time entry, provide null to keep the current hours
ratenumber | null · double
The rate of the time entry.
billingTypestring · enum
Enum values:
nonBillable
billable
fixedFee
activityCodestring | null
LEDES activity code
taskCodestring | null
LEDES task code

UserList

userIdstring · uuid · required
The unique identifier of the user
namestring · minLength: 1 · required
The name of the user
firstNamestring · minLength: 1 · required
The first name of the user
lastNamestring · minLength: 1 · required
The last name of the user
rolestring · enum · required
The role of the user
Enum values:
principal
attorney
paralegal
timekeeper
operator
accountant
emailstring · minLength: 1 · required
The email address of the user

initialsstring | null
The initials of the user

UserListIEnumerableResponse

dataarray | null
The data returned by the API

UserReference

firstNamestring · minLength: 1 · required
The first name of the user
lastNamestring · minLength: 1 · required
The last name of the user

namestring | null
The name of the user
initialsstring | null
The initials of the user