Client
Description: Represents a client entity in the system. Clients are organizations or individuals that engage the services of the firm.
Type Structure
Type Name: Client
Fields:
Id:String!- Unique identifier for the clientNumber:String!- Client reference number (e.g., CLI-2023-001)Name:String!- Name of the client organization or individual
Example Usage
The Client type is typically returned as part of other queries, such as when fetching matters:
cURL
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
"query": "query { AllMatters { Id Number Name Client { Id Number Name } } }"
}' \
https://sandbox.drivepractice.com/api/v1/graphqlExample Response
{
"data": {
"AllMatters": [
{
"Id": "5f8d0d5a7b3e4f1234567890",
"Number": "MAT-2023-001",
"Name": "Corporate Restructuring Project",
"Client": {
"Id": "5f8d0d5a7b3e4f1234567891",
"Number": "CLI-2022-456",
"Name": "Acme Corporation"
}
}
]
}
}Field Details
Id
- Type:
String!(Non-null String) - Description: System-generated unique identifier for the client
- Example:
"5f8d0d5a7b3e4f1234567891" - Usage: Used for internal references and relationships
Number
- Type:
String!(Non-null String) - Description: Human-readable reference number assigned to the client
- Example:
"CLI-2022-456" - Format: Typically follows a pattern like
CLI-YYYY-NNNwhere YYYY is the year and NNN is a sequential number - Usage: Used for client identification in documents and communications
Name
- Type:
String!(Non-null String) - Description: Full name of the client organization or individual
- Example:
"Acme Corporation" - Usage: Display purposes and client identification
Relationships
The Client type is referenced by:
- Matter: Each matter has exactly one associated client (non-null relationship)
Best Practices
- Client Identification: Use the
Numberfield for client references in external systems - Display: Use the
Namefield for displaying client information to users - Relationships: When querying matters, include the Client fields to get complete client information
Common Use Cases
- Client Management: Track and manage client information
- Matter Association: Associate matters with specific clients
- Reporting: Generate reports filtered by client
- Billing: Associate time entries with specific clients through matters